如何利用FluentMigrator实现数据库迁移

FluentMigrator

Fluent Migrator是一个基于.NET的迁移框架,你可以像使用Ruby on Rails Migrations一样使用它。Fluent Migrator的最新版本是3.13版,官网地址https://github.com/fluentmigrator/fluentmigrator。 你可以使用C#编写数据库迁移类,而不需要编写任何SQL脚本。从使用方式上看,它非常像EF/EF Core的数据库迁移脚本,但是它支持的数据库类型比EF/EF Core多的多,且不受限与EF/EF Core。

支持的数据库列表

  • Microsoft SQL Server 2017
  • Microsoft SQL Server 2016
  • Microsoft SQL Server 2014
  • Microsoft SQL Server 2008
  • Microsoft SQL Server 2005
  • Microsoft SQL Server 2000
  • Microsoft SQL Server Compact Edition
  • PostgreSQL
  • MySQL 4
  • MySQL 5
  • Oracle
  • Oracle (managed ADO.NET)
  • Oracle (DotConnect ADO.NET)
  • Microsoft JET Engine (Access)
  • SQLite
  • Firebird
  • Amazon Redshift
  • SAP Hana
  • SAP SQL Anywhere
  • DB2
  • DB2 iSeries

Fluent Migrator提供了5个不同的类库来支持不同的场景。

Package 描述
FluentMigrator 创建数据库所需的基础程序集
FluentMigrator.Runner 进程内执行数据库迁移所需的程序集
FluentMigrator.Console 进程外执行数据库迁移所需的程序集,它兼容.NET 4.0/4.5/.NET Core 2.0
FluentMigrator.MSBuild 兼容.NET 4.0/4.5/.NET Standard 2.0的MSBuild任务
FluentMigrator.DotNet.Cli 可执行数据库迁移的.NET Core CLI工具

入门例子

这里我们首先演示一个最简单的数据库迁移例子,为一个MySql数据库添加一个日志表。

创建控制台程序

我们使用.NET Core CLI创建一个.NET Core的命令行程序。

# 迁移脚本基础库
dotnet add package FluentMigrator

# 迁移脚本运行库
dotnet add package FluentMigrator.Runner

# 针对MySQL的迁移脚本支持库
dotnet add package FluentMigrator.Runner.MySQL

# ADO.NET针对MySQL的驱动器
dotnet add package MySQL.Data

添加第一个数据库迁移类

未了创建一个名为Log的表,这里需要创建一个数据库迁移类

  • Log表中有2个字段,一个是Id字段,一个是Text字段
  • Id字段是Int64类型的主键,且自增
  • Text字段是字符串字段
using FluentMigrator;

namespace test
{
 [Migration(20180430121800)]
 public class AddLogTable : Migration
 {
  public override void Up()
  {
   Create.Table("Log")
    .WithColumn("Id").AsInt64().PrimaryKey().Identity()
    .WithColumn("Text").AsString();
  }

  public override void Down()
  {
   Delete.Table("Log");
  }
 }
}

运行迁移类

编写完迁移类之后,我们就可以开始运行迁移类了。

Fluent Migrator有两种运行迁移脚本的方式。

  • 使用进程内执行器(推荐)
  • 使用进程外执行器

使用进程内执行器

所谓的进行内执行器,其实就是借助FluentMigrator.Runner库,在程序内部手动调用IMigrationRunner接口对象的MigrateUp方法执行数据库迁移。

这里我们可以修改Program.cs文件如下。

 class Program
 {
  static void Main(string[] args)
  {
   var serviceProvider = CreateServices();

   using (var scope = serviceProvider.CreateScope())
   {
    UpdateDatabase(scope.ServiceProvider);
   }
  }

  private static IServiceProvider CreateServices()
  {
   return new ServiceCollection()
    //添加FluentMigrator基础服务
    .AddFluentMigratorCore()
    .ConfigureRunner(rb => rb
     //添加MySql 5.0支持
     .AddMySql5()
     //配置连接字符串
     .WithGlobalConnectionString("server=localhost;port=3307;Database=abc;UID=root;PWD=123456")
     //检索迁移配置
     .ScanIn(typeof(AddLogTable).Assembly).For.Migrations())
    //启用控制台日志
    .AddLogging(lb => lb.AddFluentMigratorConsole())
    //构建服务提供器
    .BuildServiceProvider(false);
  }

  private static void UpdateDatabase(IServiceProvider serviceProvider)
  {
   //初始化进程内迁移构建器
   var runner = serviceProvider.GetRequiredService<IMigrationRunner>();

   //执行迁移脚本
   runner.MigrateUp();
  }
 }

启动程序之后,迁移自动完成。

使用进程外执行器

如果你想使用进行外迁移执行器,这里首先需要保证你已经安装了.NET Core 2.1或以上版本的SDK, 因为你需要使用.NET Core 2.1之后新增的Global Tool功能。

这里我们可以使用命令行,添加FluentMigrator.DotNet.Cli这个工具

dotnet tool install -g FluentMigrator.DotNet.Cli

安装完成之后,我们就可以使用这个工具来做数据库迁移了

dotnet fm migrate -p mysql -c "server=localhost;port=3307;Database=abc;UID=root;PWD=123456" -a ".\bin\Debug\netcoreapp2.1\test.dll"

这个方法有3个参数, 第一个参数-p指定了数据库的类型,第二个参数-c指定了连接字符串,第三个参数-a指定了包含迁移类的程序集路径。

注意:其实这里还有第四个参数command, 可选值为down/up, 如果不指定,默认是up, 即运行所有还未运行过的数据库迁移类。

方法执行后,效果和进程内执行器的效果一致。

基本概念

在展示了一个简单示例之后,我们接下来看一下Fluent Migrator中的一些基本概念。

迁移(Migrations)

Fluent Migrator中最基础的元素是迁移类,每个迁移类都需要继承自一个名为Migration的抽象类,并实现两个抽象方法Up和Down, 顾名思义Up方法即执行当前的数据库变更,Down方法即回滚当前的数据库变更。

[Migration(1)]
public class CreateUserTable : Migration
{
 public override void Up()
 {
  Create.Table("Users");
 }

 public override void Down()
 {
  Delete.Table("Users");
 }
}

这里你可能注意到迁移类的头部,有一个Migration的特性,它的值是1, 这里其实是指定了迁移类执行的顺序,编号越小的迁移类越先执行(有一部分开发人员系统会使用当前日期的yyyyMMddHHmmss格式来标记迁移类),这个编号必须是唯一的,不能重复。

Fluent接口(Fluent Interface)

Fluent Migrator提供非常丰富的fluent api, 我们可以使用这些api来创建表,列,索引。 基本上你能用到的大部分场景它都支持。

创建表达式(Create Expression)

你可以使用它创建表达式来添加表,列,索引,外键,组织结构(schema)

Create.Table("Users")
  .WithIdColumn()
  .WithColumn("Name").AsString().NotNullable();

注:WithIdColumn()是一个扩展方法,它等价于.WithColumn("Id").AsInt32().NotNullable().PrimaryKey().Identity();

Create.ForeignKey()
  .FromTable("Users").ForeignColumn("CompanyId")
  .ToTable("Company").PrimaryColumn("Id");

变更表达式(Alter Expression)

用来变更已存在的表和列

Alter.Table("Bar")
  .AddColumn("SomeDate")
  .AsDateTime()
  .Nullable();
Alter.Table("Bar")
  .AlterColumn("SomeDate")
  .AsDateTime()
  .NotNullable();
Alter.Column("SomeDate")
  .OnTable("Bar")
  .AsDateTime()
  .NotNullable();

删除表达式(Delete Expression)

用来删除表,列,外键,组织结构(Schema)

Delete.Table("Users");

删除多个列(Delete Multiple Columns)

Fluent Migrator也提供了一个删除多列的语法

Delete.Column("AllowSubscription").Column("SubscriptionDate").FromTable("Users");

执行脚本(Execute Expression)

允许你执行自定义的SQL脚本或执行指定的SQL脚本文件

Execute.Script("myscript.sql");
Execute.EmbeddedScript("UpdateLegacySP.sql");
Execute.Sql("DELETE TABLE Users");

这里EmbeddedScript方法也是执行指定的SQL脚本文件,但是它的文件来源Embbed Resource中读取。如果你想使用EmbbedScript只需要将指定的SQL脚本文件的Build Action属性设置为Embbed Resource即可。

重命名表达式(Rename Expression)

允许重命名表或列

Rename.Table("Users").To("UsersNew");
Rename.Column("LastName").OnTable("Users").To("Surname");

数据操作表达式(Data Expressions)

允许对数据库数据进行新增/修改/删除操作

Insert.IntoTable("Users").Row(new { FirstName = "John", LastName = "Smith" });
Delete.FromTable("Users").AllRows(); //删除所有行
Delete.FromTable("Users").Row(new { FirstName = "John" }); //删除所有FirstName = John的数据行
Delete.FromTable("Users").IsNull("Username"); //删除所有Username为空的数据行
Update.Table("Users").Set(new { Name = "John" }).Where(new { Name = "Johnanna" });

数据库类型判断表达式(IfDatabase Expression)

允许根据数据库类型,执行不同的数据库迁移操作

IfDatabase("SqlServer", "Postgres")
  .Create.Table("Users")
  .WithIdColumn()
  .WithColumn("Name").AsString().NotNullable();

IfDatabase("Sqlite")
  .Create.Table("Users")
  .WithColumn("Id").AsInt16().PrimaryKey()
  .WithColumn("Name").AsString().NotNullable();

组织结构存在表达式(Schema.Exists Expressions)

用来判断组织结构是否已经存在,列如判断表是否存在,列是否存在等等。

if (!Schema.Table("Users").Column("FirstName").Exists())
{
  this.Create.Column("FirstName").OnTable("Users").AsAnsiString(128).Nullable();
}

配置(Profile)

Fluent Migrator还提供了一个Profile的特性,使用该配置,开发人员可以对针对的不同的环境(开发环境,测试环境,生产环境等)运行不同的脚本。

[Profile("Development")]
public class CreateDevSeedData : Migration
{
  public override void Up()
  {
    Insert.IntoTable( "User" ).Row( new
      {
        Username = "devuser1",
        DisplayName = "Dev User"
      });
  }

  public override void Down()
  {
    //empty, not using
  }
}

和EF/EF Core的脚本迁移比较

Fluent Migrator的数据库脚本迁移与EF/EF Core非常类似。

相似点:

  • 当我们使用EF/EF Core做数据库迁移的时候,会在当前数据库中创建一个__EFMigrationsHistory表,并在其中保存运行过的脚本Id。
  • 当我们使用Fluent Migrator做数据库迁移的时候,也会在数据库中创建一个VersionInfo表,并在其中保存运行过的脚本Id

区别:

  • EF/EF Core的迁移脚本是根据EF上下文配置以及最新的ModelSnapshot自动生成的,更方便一些。Fluent Migrator的迁移脚本,都需要自己手动编写, 更灵活一些。
  • EF/EF Core每次自动生成的迁移文件一个cs文件一个Design.cs文件,每个cs文件中包含了自动生成的脚本类,Design.cs里面包含了针对当前迁移类的最新ModelSnapshot, 所以重度使用EF/EF Core, 最后累计生成的Design.cs文件都会非常大。Fluent Migrator的每个迁移类都是自己编写的,只包含本次迁移的内容,所以体积更小。

总结

本篇中我描述了Fluent Migrator的一些基本用法,以及它与EF/EF Core脚本迁移的区别, 如果你不是重度EF/EF Core的使用者,可以尝试一下使用Fluent Migrator来做数据库迁移。

好了,以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,谢谢大家对我们的支持。

时间: 2019-04-03

asp.net mvc CodeFirst模式数据库迁移步骤详解

利用Code First模式构建好基本的类后,项目也开始搭建完毕并成功运行,而且已经将数据库表结构自动生成了. 但是,我有新的类要加入,有字段需要修改,那怎么办呢,删库,跑路 ? 哈哈 利用数据库迁移,将原有结构不改动,将新建类进行单独建表操作,或者是已有数据库表,改变字段,那就修改表. 迁移步骤: 1.打开程序包管理器控制台:工具->NuGet包管理器->程序包管理器控制台.(当然还有其它方式也可以打开,我比较喜欢这种) 点击后将弹出程序包管理器控制台 极其要注意的是默认项目!!! 2.启动

在.NET Core类库中使用EF Core迁移数据库到SQL Server的方法

前言 如果大家刚使用EntityFramework Core作为ORM框架的话,想必都会遇到数据库迁移的一些问题. 起初我是在ASP.NET Core的Web项目中进行的,但后来发现放在此处并不是很合理,一些关于数据库的迁移,比如新增表,字段,修改字段类型等等,不应该和最上层的Web项目所关联,数据的迁移文件放到这里也感觉有点多余,有点乱乱的感觉,所以才想着单独出来由专门的项目进行管理会比较好,也比较清晰! 注意目标框架选择的是.NET Core 2.0而不是.NET Standard 2.0.

.net core实用技巧——将EF Core生成的SQL语句显示在控制台中

前言 笔者最近在开发和维护一个.NET Core项目,其中使用几个非常有意思的.NET Core相关的扩展,在此总结整理一下. EF Core性能调优 如果你的项目中使用了EF Core, 且正在处于性能调优阶段,那么了解EF Core生成的SQL语句是非常关键的.那么除了使用第三方工具,如何查看EF Core生成的SQL语句呢?这里笔者将给出一个基于.NET Core内置日志组件的实现方式. 创建一个实例项目 我们首先建一个控制台程序,在主程序中我们编写了一个最简单的EF查询. class P

浅谈mybatis中的#和$的区别 以及防止sql注入的方法

mybatis中的#和$的区别 1. #将传入的数据都当成一个字符串,会对自动传入的数据加一个双引号.如:order by #user_id#,如果传入的值是111,那么解析成sql时的值为order by "111", 如果传入的值是id,则解析成的sql为order by "id". 2. $将传入的数据直接显示生成在sql中.如:order by $user_id$,如果传入的值是111,那么解析成sql时的值为order by user_id,  如果传入的

sqlserver中通过osql/ocmd批处理批量执行sql文件的方法

利用osql/ocmd批处理批量执行sql文件 注意:在上图中我们可以看到osql 并不支持 SQL Server 2008的所有功能,如果需要使用SQL Server 2008的所有功能可以使用ocmd命令. 有了osql/ocmd命令要批量执行sql文件当然需要写一个批处理命令,例如我们执行上面sql文件就可以在txt中编写下面的语句: 复制代码 代码如下: osql -S"127.0.0.1" -U"sa" -P"sa" -d"N

Java实现把excel xls中数据转为可直接插入数据库的sql文件

我的一贯风格,代码说明一切.. 废话不多说了,直接给大家贴代码了,具体代码如下所示: package Tools; import java.io.BufferedWriter; import java.io.File; import java.io.FileWriter; import java.io.IOException; import java.lang.reflect.Field; import java.util.ArrayList; import java.util.List; im

Python的Flask框架中使用Flask-Migrate扩展迁移数据库的教程

我们在升级系统的时候,经常碰到需要更新服务器端数据结构等操作,之前的方式是通过手工编写alter sql脚本处理,经常会发现遗漏,导致程序发布到服务器上后无法正常使用. 现在我们可以使用Flask-Migrate插件来解决之,Flask-Migrate插件是基于Alembic,Alembic是由大名鼎鼎的SQLAlchemy作者开发数据迁移工具. 具体操作如下: 1. 安装Flask-Migrate插件 $ pip install Flask-Migrate 2. 修改Flask App部分的代

.net core项目中常用的几款类库详解(值得收藏)

前言 至2002微软公司推出.NET平台已近15年,在互联网快速迭代的浪潮中,许多语言已被淘汰,同时也有更多新的语言涌现,但 .Net 依然坚挺的站在系统开发平台的一线阵营中,并且随着.NET Core正式版的到来,迎来新一轮春天. 本文主要给大家介绍了关于.net core项目中常用的几款类库的相关内容,分享出来供大家参考学习,下面话不多说了,来一起看看详细的介绍吧. 汉字转拼音 1. HxfPinYin 这是我自己根据网上大神提供的源码,再.net core 框架下编译出的类库 主要提供汉字

如何在ASP.NET Core类库项目中读取配置文件详解

前言 最近有朋友问如何在.net core类库中读取配置文件,当时一下蒙了,这个提的多好,我居然不知道,于是这两天了解了相关内容才有此篇文章的出现,正常来讲我们在应用程序目录下有个appsettings.json文件对于相关配置都会放在这个json文件中,但是要是我建立一个类库项目,对于一些配置比如密钥或者其他需要硬编码的数据放在JSON文件中,在.net core之前配置文件为web.config并且有相关的类来读取节点上的数据,现如今在.net core中为json文件,那么我们该如何做?本

ASP.NET 5已终结,迎来ASP.NET Core 1.0和.NET Core 1.0

ASP.NET 在过去的 15 年里是个非常不错的"品牌". ASP.NET 4.6 已经支持在生产环境使用:http://get.asp.net. 但是,命名是新的,完全截取自 ASP.NET 框架 -- "ASP.NET 5",但这并不是个好主意,其中一个原因是:5 > 4.6,这样看起来 ASP.NET 5 比 ASP.NET 4.6 版本号更大,更好,甚至是可以替代 ASP.NET 4.6. 所以修改了名字,选择了一个更好的版本号. 重新引入 ASP.

SQL Server 2008中的数据表压缩功能详细介绍

SQL Server 2005 SP2为我们带来了vardecimal功能,当时针对decimail和numeric数据类型推出了新的存储格式--vardecimal.vardecimal存储格式允许 decimal和numeric数据类型的存储作为一个可变长度列. 这项功能使得原来定长的decimal数据在数据文件中以可变长的格式存储,据称这项功能可以为典型的数据仓库节省30%的空间,而SQL Server 2008在这一基础上又进一步增强了数据压缩功能.SQL Server 2008现在支持