欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Entityframework Migrations

程序员文章站 2022-07-06 11:46:22
EF相关的内容园子里已经有很多很好的文章了,这篇只是把自己之前的一些整理搬运到这里,抛砖引玉,温故知新。 Migrations确实是个好东西,至少就升级维护Database方面,帮助笔者脱离苦海。另一个项目中开发阶段忽视了DB升级的处理方面的问题,导致每次项目上线都很难去处理DB。因为只有最新版本的 ......

  ef相关的内容园子里已经有很多很好的文章了,这篇只是把自己之前的一些整理搬运到这里,抛砖引玉,温故知新。


migrations确实是个好东西,至少就升级维护database方面,帮助笔者脱离苦海。另一个项目中开发阶段忽视了db升级的处理方面的问题,导致每次项目上线都很难去处理db。因为只有最新版本的script,如果表结构没有变化还好一点,如果表结构有变动几乎没办法处理。甚至很难比对出上一次release版本的db和最新的db之间的区别。
利用migrations,我们可以记录每次db的变动,甚至可以将初始化的数据处理成一个单独的migrations用于restore db. 对于某些基于特定版本的问题,也可以轻松的将db还原到出现问题的环境。
正文:
既可以利用entity去生成migrations,也可以通过工具利用现有的db去生成migrations.
准备工作(具体怎么安装,容我再研究一下):

(目前最新版本应该是2.2,参见园子里的)
entity framework core .net command line tools 2.0.0-rtm-26452

  • microsoft.entityframeworkcore.sqlserver 2.0.3
  • microsoft.entityframeworkcore.tools 2.0.3
  • microsoft.entityframeworkcore.design 2.0.3

dotnetclitoolreference:

microsoft.entityframeworkcore.tools.dotnet 2.0.0

以code first由entity生成migrations为例(笔者使用的是abp,具体使用时集成的类与接口可能会有出入)

1 public class area : fullauditedentity, imusthavetenant
2 {
3     public virtual string name { get; set; }
4     public virtual string remark { get; set; }
5     public virtual string indextitle { get; set; }
6     public int tenantid { get; set; }
7 }

 

此处由于集成自fullauditedentity类,会自动的为area的entity添加自增的id,以及类似与creationtime等统计相关的字段.
entity建好之后,需要在xxxdbcontext中声明一下你的entity.
public virtual dbset

area { get; set; }
此处有两个作用

生成migrations时确保识别出这个entity
允许使用repository

与dotnet命令类似,dotnet ef的相关命令都可以使用 --help来查看具体用法.
我们使用dotnet ef migrations add addarea命令来为刚刚创建的entity生成migrations.
这个命令会添加两个新的文件,分别是对应的migrations文件和designer文件.另外这个命令会修改x'x'xdbcontextmodelsnapshot.cs 文件.暂时我们只需要关注migrations文件
例如

 1 public partial class addindextitle : migration
 2 {
 3     protected override void up(migrationbuilder migrationbuilder)
 4     {
 5         migrationbuilder.addcolumn(
 6             name: "indextitle",
 7             table: "component",
 8             nullable: true);
 9 
10         migrationbuilder.addcolumn(
11             name: "indextitle",
12             table: "area",
13             nullable: true);
14     }
15

16   protected override void down(migrationbuilder migrationbuilder) 17   { 18     migrationbuilder.dropcolumn( 19       name: "indextitle", 20       table: "component"); 21 22     migrationbuilder.dropcolumn( 23       name: "indextitle", 24       table: "area"); 25   } 26 }

 

(此处只是举例说明,并非实际由area实体生成的migration)
可以看到两个方法up和down,这两个方法就是你在升级或降级db时会去执行的方法。
当然你也可以不写实体,直接生成一个空的migration文件来初始化数据等.如

public partial class initialdb: migration
{
  protected override void up(migrationbuilder migrationbuilder)
  {
    var sql = “insert into ....”
    migrationbuilder.sql(sql);
  }

  protected override void down(migrationbuilder migrationbuilder)
  {

  }
}

 

如果你不需要或者是想删除这个migration 使用命令
dotnet ef migrations remove
这个命令会依次倒叙移除你的migration,前提是这个migrations没有更新到db中.
成功生成migration后需要把migration的改动升级到db中,此时需要执行命令
dotnet ef database update
这个命令如果不添加任何参数,无论你的db当前处于哪个migration,都会更新到最新的migration.
如果你在update后添加 某一个migration的名字作为参数,db将更新至指定的migration(可以降级db)
当然以上所有工作的前提都是你要连接到某一个真实存在的db,连接的方式不再赘述了.
此外,如果是某些特定环境,你不能或很难去执行上面的命令来更新db.
这时你可以将migrator文件publish出来,作为一个单独的项目去执行,当然你要修改对应的config文件来确保你的配置正确。
之后更新db时你只需要在这个migrator包的路径下cmd中执行
dotnet xxxx.migrator.dll (具体名字未定,并非一定是migrator)来更新db.