flyway使用说明

最新推荐文章于 2024-06-15 10:11:22 发布

心印语

最新推荐文章于 2024-06-15 10:11:22 发布

阅读量2.1k

点赞数 2

文章标签：中间件

本文链接：https://blog.csdn.net/ly554369080/article/details/124196206

版权

Flyway是一款数据库迁移（migration）工具。简单点说，就是在你部署应用的时候，帮你执行数据库脚本的工具。Flyway支持SQL和Java两种类型的脚本，你可以将脚本打包到应用程序中，在应用程序启动时，由Flyway来管理这些脚本的执行，这些脚本被Flyway称之为migration.

引入Flyway之后的应用部署流程大概是这样的：
开发人员将应用程序打包
应部署人员拿到应用部署包，备份、替换，以完成应用程序升（Flyway将自动执行升级/备份脚本）

xds项目集成flyway：—
1.maven引入jar包：
org.flywaydb
flyway-core

版本号也可以使用pluginManagement默认版本，没必要自己指定版本

2.yml文件配置：
flyway:
enabled: true #是否开启flyway，默认true.
baseline-on-migrate: true #当迁移时发现目标schema非空，而且带有没有元数据的表时，是否自动执行基准迁移，默认false.
clean-on-validation-error: true #当发现校验错误时是否自动调用clean，默认false.
sql-migration-prefix: V #迁移文件的前缀，默认为V
sql-migration-suffixes: .sql #移脚本的后缀，默认为.sql
locations: -classpath:db/migration/mysql #迁移脚本的位置，默认db/migration.可以多个，可以给每个环境使用不同位置
ignore-missing-migrations: true #忽略缺失的升级脚本验证
更多参考：
flyway.baseline-description对执行迁移时基准版本的描述.
flyway.baseline-on-migrate当迁移时发现目标schema非空，而且带有没有元数据的表时，是否自动执行基准迁移，默认false.
flyway.baseline-version开始执行基准迁移时对现有的schema的版本打标签，默认值为1.
flyway.check-location检查迁移脚本的位置是否存在，默认false.
flyway.clean-on-validation-error当发现校验错误时是否自动调用clean，默认false.
flyway.enabled是否开启flywary，默认true.
flyway.encoding设置迁移时的编码，默认UTF-8.
flyway.ignore-failed-future-migration当读取元数据表时是否忽略错误的迁移，默认false.
flyway.init-sqls当初始化好连接时要执行的SQL.
flyway.locations迁移脚本的位置，默认db/migration.
flyway.out-of-order是否允许无序的迁移，默认false.
flyway.password目标数据库的密码.
flyway.placeholder-prefix设置每个placeholder的前缀，默认${.
flyway.placeholder-replacementplaceholders是否要被替换，默认true.
flyway.placeholder-suffix设置每个placeholder的后缀，默认}.
flyway.placeholders.[placeholder name]设置placeholder的value
flyway.schemas设定需要flywary迁移的schema，大小写敏感，默认为连接默认的schema.
flyway.sql-migration-prefix迁移文件的前缀，默认为V.
flyway.sql-migration-separator迁移脚本的文件名分隔符，默认__
flyway.sql-migration-suffix迁移脚本的后缀，默认为.sql
flyway.tableflyway使用的元数据表名，默认为schema_version
flyway.target迁移时使用的目标版本，默认为latest version
flyway.url迁移时使用的JDBC URL，如果没有指定的话，将使用配置的主数据源
flyway.user迁移数据库的用户名
flyway.validate-on-migrate迁移时是否校验，默认为true.

3.flyway默认的版本flyway_schema_history表：

CREATE TABLE flyway_schema_history
	(
	installed_rank INT NOT NULL,
	version VARCHAR(50),
	description VARCHAR(200) NOT NULL,
	type VARCHAR(20) NOT NULL,
	script VARCHAR(1000) NOT NULL,
	checksum INT,
	installed_by VARCHAR(100) NOT NULL,
	installed_on TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
	execution_time INT NOT NULL,
	success TINYINT(1) NOT NULL,
	PRIMARY KEY (installed_rank),
	INDEX flyway_schema_history_s_idx (success)
	)
	ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

特别注意事项：

1. sql 命名规范：命名为：Vx.x.x__ xxx.sql数据库文件。V+版本号+双下划线+描述.结束符(默认sql) , V大写，中间是两个下划线（__），注意是两个下滑线一起_ _ 
2.迁移脚本sql的位置：使用idea使用.创建文件夹路径时一定要注意，例如创建a/b/c.file文件时，使用idea创建文件夹a.b会默认 a.b是一个文件名，要确认检查脚本文件是否在正确路径下
3.Fayway在每次应用启动时检测是否有需要执行的升级脚本：
  脚本文件以V作为前缀的，后跟版本号，版本号格式可以为为大版本号（1、2），也可以包含小版本号(1.1或1_1)，但是需统一，不能有些有小版本号，有些没有,  前缀为 V的脚本不可重复执行，每个脚本只会被执行一次。已经执行过的历史版本脚本不能再修改，除非清除flayway的历史记录，重新执行升级脚本，这在生产环境不允许, 前缀为 R的脚本，后面无版本号，如R__update_version.sql，可以重复执行，每次内容发生变化时重启后就会执行
4. Flyway需要创建存储脚本升级记录用的表，因此需要建表权限，也可以事先建好。默认表名为flyway_schema_history  sql脚本需要有相应的版本号，例如如果想让 V2__init.sql执行 需要有V1__init.sql作为一个基准对比，然后flyway才会执行相应的sql脚本。所以V开头的文件只能新增  
5. flyway 开发规范
a. 已经提交的 flyway 脚本不可删除；
b. 已经提交的 flyway 脚本不可修改；
c. 已经提交的 flyway 脚本可重复执行

例如这些版本号都可以：
1个
001
5.2
205.68
20130115113556
2013.1.15.11.35.56
2013.01.15.11.35.56

在这里插入图片描述