一.管理資料庫架構概述 EF Core 提供兩種主要方法來保持 EF Core 模型和資料庫架構同步。一是以 EF Core 模型為基準,二是以資料庫為基準。 (1)如果希望以 EF Core 模型為準,請使用遷移。 對 EF Core 模型進行更改時,此方法會以增量方式將相應架構更改應用到資料庫, ...
一.管理資料庫架構概述
EF Core 提供兩種主要方法來保持 EF Core 模型和資料庫架構同步。一是以 EF Core 模型為基準,二是以資料庫為基準。
(1)如果希望以 EF Core 模型為準,請使用遷移。 對 EF Core 模型進行更改時,此方法會以增量方式將相應架構更改應用到資料庫,以使資料庫保持與 EF Core 模型相容。
(2)如果希望以資料庫架構為準,請使用反向工程。 使用此方法,可通過將資料庫架構反向工程到 EF Core 模型來生成相應的 DbContext 和實體類型。
1.1. 遷移概述
在開發期間,數據模型發生更改後,會與資料庫不同步。 雖然可以刪除該資料庫,讓 EF 創建一個新的資料庫來匹配該模型,但此過程會導致數據丟失。遷移作用是指:在 EF Core 中使用遷移功能,能夠以遞增方式更新資料庫架構,使其與應用程式的數據模型保持同步,同時保留資料庫中的現有數據。
遷移包括 命令行工具和API,可協助執行以下任務:
(1) 創建遷移。 生成資料庫更新的代碼腳本,用來準備將應用模型同步到資料庫。
(2) 更新資料庫。通過“創建遷移”的代碼腳本,同步資料庫。
(3) 自定義遷移代碼。有時需要修改或補充應用模型,並同步資料庫。
(4) 刪除遷移。 刪除生成的遷移版本(該版本沒有更新到資料庫)。
(5) 還原遷移。 撤消回滾資料庫更改(該版本已更新到資料庫)。
(6) 生成 SQL腳本。 可能需要一個腳本來更新生產資料庫,或者對遷移代碼進行故障排除。
(7) 在運行時應用遷移。 如果在設計期間更新和運行腳本不是最佳選項時,可在運行時調用 Migrate() 方法。
2.1 安裝命令工具
(1)對於Visual Studio開發,建議使用Package Manager Console(程式包管理器控制台)工具,使用windows上的PowerShell腳本。
(2)對於其他開發環境,請選擇.NET Core CLI工具,使用dotnet命令是跨平臺的。
本篇使用Visual Studio開發,使用Package Manager Console工具來進行遷移管理,用PowerShell腳本,並附帶上跨平臺管理 的dotnet命令。還是使用Blog和Post應用模型來演示。
二. 命令演示
2.1 創建遷移
在定義初始化模型後,即應創建資料庫。 若要添加初始遷移,請運行以下命令,其中InitialCreate屬於自定義遷移類名,它繼承了DbContext。
PowerShell | dotnet |
Add-Migration InitialCreate | dotnet ef migrations add InitialCreate |
關於準備工作和創建遷移註意事項這裡不在說明,請參考“asp.net core 系列 20 EF基於數據模型創建資料庫”。在開發中,一般都是使用多層架構,這裡新建了一個實體類庫EFGetStarted.AspNetCore.Model,在web項目的"依賴項"上右擊添加引用,選擇實體類庫。
在實體類庫上安裝資料庫提供程式。創建三個類BloggingContext類(繼承DbContext)、Blog實體類、Post實體類。接著使用Package Manager Console工具運行Add-Migration InitialCreate命令。如下所圖所示:
當運行了Add-Migration InitialCreate後,將在項目中生成一個Migrations 文件夾,併在其中生成三個文件,文件名中的時間戳有助於保證文件按時間順序排列:
(1) 00000000000000_InitialCreate.cs--主遷移文件。 包含應用遷移所需的操作 Up() 和還原遷移所需的操作Down() 。
(2) 00000000000000_InitialCreate.Designer.cs--遷移元數據文件。 包含 EF 所用的信息,如給實體類型構建屬性、主鍵、外鍵、索引、映射到數據表,主體和依賴關係等等,如下所示:
(3) BloggingContextModelSnapshot.cs - 當前模型的快照。用於確定添加下一次遷移時更改的內容(用於遞增更新)。
2.2 更新資料庫
接下來,將遷移應用於資料庫以創建架構。命令如下:
PowerShell | dotnet |
Update-Database InitialCreate | dotnet ef database update InitialCreate |
註意:更新到資料庫,需要創建資料庫的連接。項目中配置資料庫連接,一般是存放在web項目的appsettings.json文件中,併在Startup類中調用。這裡演示是直接寫死在Startup類代碼中,如下所示:
var connection = "Data Source = {ip}; Initial Catalog = EFGetStarted.AspNetCore.NewDb; User ID = hsr;Password =js*2015;"; services.AddDbContext<BloggingContext> (options => options.UseSqlServer(connection));
在Package Manager Console工具中,運行Update-Database InitialCreate命令,同步到資料庫,如下所示:
2.3 自定義遷移代碼
更改 EF Core 模型後,資料庫架構可能不同步。為使其保持最新,請再添加一個新的遷移。例如我在Blog實體類,新添加了一個屬性,和修改了一個屬性的CLR類型。
public class Blog { public int BlogId { get; set; } //將string 改為char public char Name { get; set; } //新增一個屬性 public string Title { get; set; } public string Url { get; set; } public ICollection<Post> Posts { get; set; } }
運行Add-Migration Blog_Modifier,添加一個新的遷移
再運行Update-Database Blog_Modifier,同步到資料庫中。char類型的Name生成後預設是nvarchar(1),對於指定屬性的長度,參考上篇關係資料庫建模。
查看資料庫的遷移歷史,可以查看到遷移ID MigrationId,其中20190222031152_Blog_Modifier 是最新的遷移同步到資料庫的版本。
2.3.1 空遷移
有時模型未變更,直接添加遷移也很有用處。 在這種情況下,添加新遷移會創建一個帶空類的代碼文件。可以自定義此遷移,執行與 EF Core 模型不直接相關的操作。 可能需要通過此方式管理的一些事項包括:
(1)全文搜索
(2)函數
(3)存儲過程
(4)觸發器
(5)視圖
通過上面操作,以Code First模式下,不需要對資料庫進行直接操作,在資料庫建模上,DBA以檢查資料庫架構為主。
2.4 刪除遷移
有時修,項目在添加遷移後,意識到需要在應用遷移前對 EF Core 模型作出其他更改。 要刪除上個遷移。 刪除遷移是使用了Add-Migration生成遷移後,還沒有應用Update-Database同步到資料庫架構。請使用如下命令。
PowerShell | dotnet |
Remove-Migration Name | dotnet ef migrations remove Name |
2.5 還原遷移
如果已經對資料庫應用一個遷移(或多個遷移),但需將其複原(回滾),需要使用更新資料庫命令,並指定回滾時的目標遷移名稱。下麵還原到遷移名稱InitialCreate狀態時。運行PM> Update-Database InitialCreate後,資料庫同步,回到了最初InitialCreate遷移狀態,資料庫Blogs表還原到了當初。
2.6 生成 SQL 腳本
調試遷移或將其部署到生產資料庫時,生成一個 SQL 腳本很有幫助。 之後可進一步檢查該腳本的準確性,並對其作出調整以滿足生產資料庫的需求。 該腳本還可與部署技術結合使用。 基本命令如下。
PowerShell | dotnet |
Script-Migration | dotnet ef migrations script |
Script-Migration參數介紹:
-From<String> | 開始遷移。遷移可以通過名稱或ID來標識。數字0是一種特殊情況,這意味著在第一次遷移之前。預設值為0 |
-To<String> | 結束遷移。預設值為最後一次遷移。 |
-Idempotent | 生成可在任何遷移時在資料庫上使用的腳本。 |
-Output <String> | 要將結果寫入的文件。如果省略該參數,則在創建應用程式運行時文件的文件夾中使用生成的名稱創建文件,例如:/obj/Debug/netcoreapp2.1/ghbkztfz.sql/ |
下麵的示例使用InitialCreate遷移版本,創建一個sql腳本文件,輸出到D盤。
PM> Script-Migration -From 0 -To InitialCreate -Output D:\InitialCreate.sql
IF OBJECT_ID(N'[__EFMigrationsHistory]') IS NULL BEGIN CREATE TABLE [__EFMigrationsHistory] ( [MigrationId] nvarchar(150) NOT NULL, [ProductVersion] nvarchar(32) NOT NULL, CONSTRAINT [PK___EFMigrationsHistory] PRIMARY KEY ([MigrationId]) ); END; GO CREATE TABLE [Blogs] ( [BlogId] int NOT NULL IDENTITY, [Name] nvarchar(max) NULL, [Url] nvarchar(max) NULL, CONSTRAINT [PK_Blogs] PRIMARY KEY ([BlogId]) ); GO CREATE TABLE [Posts] ( [PostId] int NOT NULL IDENTITY, [Title] nvarchar(max) NULL, [Content] nvarchar(max) NULL, [BlogId] int NOT NULL, CONSTRAINT [PK_Posts] PRIMARY KEY ([PostId]), CONSTRAINT [FK_Posts_Blogs_BlogId] FOREIGN KEY ([BlogId]) REFERENCES [Blogs] ([BlogId]) ON DELETE CASCADE ); GO CREATE INDEX [IX_Posts_BlogId] ON [Posts] ([BlogId]); GO INSERT INTO [__EFMigrationsHistory] ([MigrationId], [ProductVersion]) VALUES (N'20190222024519_InitialCreate', N'2.2.1-servicing-10028'); GOView Code
2.7 在運行時應用遷移
某些應用程式可能希望在啟動或首次運行期間在運行時應用遷移。使用該Migrate()
方法執行此操作。
myDbContext.Database.Migrate();
註意:此方法並不適合所有場景。 儘管此方法非常適合具有本地資料庫的應用,但是大多數應用程式需要更可靠的部署策略,例如生成 SQL 腳本。
請勿在 Migrate() 前調用 EnsureCreated()。 EnsureCreated() 會繞過遷移創建架構,這會導致 Migrate() 失敗。
參考文獻: