数据库版本管理 | flyway

1. 背景需求

在数据库设计好，并生成sql后，需要将其部署起来。

1.1 传统部署方式

其对应的操作语句如下：

# 拷贝本地文件到容器
docker cp /root/myFile/user.sql mysql:/tmp/user.sql
# 在ubuntu中进入docker容器 
docker exec -it mysql bash
# 进入mysql命令行
mysql -u root -p
# 使用数据库
use 数据库名称;
# 开始注入sql文件
source /root/user.sql

1.3 Flyway部署方式

• Flyway是一款开源的数据库版本管理工具。
• 在设计好程序之后，Flyway能够通过程序自动的将sql语言部署到云端，在每次更改sql之后，不需要执行传统部署方式这些步骤。

2. Flyway

2.1 工作流程

1. 项目启动后，应用程序完成数据库连接池的建立，Flayway自动运行
2. 初次使用时，Flyway会创建一个flyway_schema_history表，用于记录sql执行记录
3. Flayway会扫描项目指定路径下（默认是classpaht:db/migration）的所有sql脚本，与flyway_schema_history表中的记录进行比对。如果数据库记录执行，与项目中的sql脚本不一致，Flyway会报错并停止项目执行。
   

2.2 flyway注意事项

1. 在flyway中sql只能放在一个文件当中；
2. flyway在执行时，先通过version的比较，版本由小到大来执行，对每个版本中的sql文件提取出一个checksum值，如果该版本文件发生更改，则报错；需要将版本恢复，或flyway_schema_history中对应的记录删除，或修改checksum对应的值，否则项目将不能运行；
3. 先将sql的记录存储到flyway的数据库当中，然后再进行sql插入操作，如果这时候sql文件的语法出现错误，则程序不能运行，此时只能够删除flyway_schema_history中对应的记录，或者提升sql文件的版本；
4. Flayway所扫描的指定路径是db/migration，建立文件过程中，如果在resource中直接新建项目db.migration，则会报错，需要逐层建立。

2.3 flyway中文件命令方式

如图所示，flyway的文件命名方式有三种，我们常用第一种，其中版本和说明之间是--进行分割。

2.4 在SpringBoot项目使用Flyway

1. 引入Flyway依赖

<!--引入flyway-->
<dependency>
    <groupId>org.flywaydb</groupId>
    <artifactId>flyway-core</artifactId>
    <version>6.1.0</version>
</dependency>

2. 添加Flyway配置

spring:
	flyway:
	    # 是否启用flyway
	    enabled: true
	    # 编码格式，默认UTF-8
	    encoding: UTF-8
	    # 迁移sql脚本文件存放路径，默认db/migration
	    locations: classpath:db/migration
	    # 迁移sql脚本文件名称的前缀，默认V
	    sql-migration-prefix: V
	    # 迁移sql脚本文件名称的分隔符，默认2个下划线__
	    sql-migration-separator: __
	    # 迁移sql脚本文件名称的后缀
	    sql-migration-suffixes: .sql
	    # 迁移时是否进行校验，默认true
	    validate-on-migrate: true
	    # 当迁移发现数据库非空且存在没有元数据的表时，自动执行基准迁移，新建schema_version表
	    baseline-on-migrate: true

3. 根据在配置文件的脚本存放路径的配置，在resource目录下建立文件夹db/migration
4. 添加需要运行的sql脚本。sql脚本的命名规范为：V+版本号(版本号的数字间以”.“或”_“分隔开)+双下划线(用来分隔版本号和描述)+文件描述+后缀名，例如：V20201100__create_user.sql。如图所示：
   
5. 启动项目。启动成功后，在数据库中可以看到已按照定义好的脚本，完成数据库变更，并在flyway_schema_history表插入了sql执行记录：
   
   

3. 待探究问题

1. flyway中checksum的实现机制