数据库版本管理：Flyway

[waltcow]

Flyway是什么？

Flyway是一款开源的数据库版本管理工具，利用简单的配置，独立跟踪进行数据版本的迭代。

Version control for your database.Robust schema evolution across all your environments. With ease, pleasure and plain SQL.

flyway基本概念

以前我们的数据库更改都是通过在某一个文件夹中添加一条sql文件，然后手动执行的。 这样在一个新环境进行数据库迁移时就会衍生出一系列的问题：

• 需要人工手动一条一条地执行这些脚本
• 有些时候，不恰当的命名会使这些sql脚本的执行顺序变得难以确定
• 如果手动执行时，脚本执行一半发生了一些其他的事情中断了执行人的操作，那么在下次执行时怎么知道当前数据库的sql执行- 到哪里了，哪些成功执行了哪些没有执行成功

所以我们迫切地需要一个工具来处理这些问题——flyway

flyway是如何工作的

flyway会在项目启动时，完成建立数据库连接池后自动执行如下操作：

• 如果数据库是一个空的数据库，flyway会创建一个名为flyway_schema_history的sql执行记录表, 如果不是一个空的数据库，flyway会跳过这一步
• flyway会扫描项目指定路径下（spring项目默认在classpath:db/migration下）的所有sql脚本，并和flyway_schema_history表下所有的脚本记录进行比对，所有版本号小于或者等于当前版本的脚本将被忽略。但是flyway会计算这些脚本的校验和，然后和数据库记录执行过的脚本比较，如果他们校验和不一致就会报错并停止项目执行
• 其余的所有脚本将会按照版本号进行排序，然后逐个执行

如果一条sql脚本执行出错，flyway会在数据库中留下一条执行出错的记录，并且这条脚本的执行将被自动回滚。版本号高于出错脚本的待执行脚本将都不会被执行，也不会留下记录

如果flyway记录表中有出错记录，那么flyway将无法执行，请手动更改脚本错误，并手动删除记录表中的这条出错记录重新启动项目。

如何使用flyway

前提：假设数据库连接池等相关配置已经设置完毕，如果没有可以参考Alibaba Druid配置

1. 导包

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

2. 添加配置

开启flyway，flyway默认为true, 所以不设置其实也行 spring.flyway.enabled=true

一些其他的可选配置

spring.flyway.tableflyway flyway记录表在数据库中的名字，默认是flyway_schema_history

spring.flyway.baseline-description对执行迁移时基准版本的描述.

spring.flyway.baseline-on-migrate当迁移时发现目标schema非空，而且带有没有元数据的表时，是否自动执行基准迁移，默认false.

spring.flyway.baseline-version开始执行基准迁移时对现有的schema的版本打标签，默认值为1.

spring.flyway.check-location检查迁移脚本的位置是否存在，默认false.

spring.flyway.clean-on-validation-error当发现校验错误时是否自动调用clean，默认false.

spring.flyway.encoding设置迁移时的编码，默认UTF-8.

spring.flyway.ignore-failed-future-migration当读取元数据表时是否忽略错误的迁移，默认false.

spring.flyway.init-sqls当初始化好连接时要执行的SQL.

spring.flyway.locations迁移脚本的位置，默认db/migration.

spring.flyway.out-of-order是否允许无序的迁移，默认false.

spring.flyway.password目标数据库的密码.

spring.flyway.placeholder-prefix设置每个placeholder的前缀，默认${.

spring.flyway.placeholder-replacementplaceholders是否要被替换，默认true.

spring.flyway.placeholder-suffix设置每个placeholder的后缀，默认}.

spring.flyway.placeholders.[placeholder name]设置placeholder的value

spring.flyway.schemas设定需要flywary迁移的schema，大小写敏感，默认为连接默认的schema.

spring.flyway.sql-migration-prefix迁移文件的前缀，默认为V.

spring.flyway.sql-migration-separator迁移脚本的文件名分隔符，默认__

spring.flyway.sql-migration-suffix迁移脚本的后缀，默认为.sql

spring.flyway.tableflyway使用的元数据表名，默认为schema_version

spring.flyway.target迁移时使用的目标版本，默认为latest version

spring.flyway.url迁移时使用的JDBC URL，如果没有指定的话，将使用配置的主数据源

spring.flyway.user迁移数据库的用户名

spring.flyway.validate-on-migrate迁移时是否校验，默认为true

3. 建立sql脚本

默认配置下flyway的脚本在resources/db/migration

命名格式为V[Version]__[Description].sql, 例如改成类似V1__Init_db.sql这种

• 以大写的 V 开头，小写的 .sql 结尾
• Version：数字和小数点组成的版本号，由用户自行定义，不能有字母, 按大小顺序递增。例如：1/2/3/3.1/3.2/3.2.1/3.2.2 等
• Description：对本 sql 文件的描述信息。
• Version 和 Description 之间用两个下划线 "__" 隔开。 例如 V2.1__first_changes.sql

4. 执行项目即可