编程开源技术交流,分享技术与知识

网站首页 > 开源技术 正文

flyway的使用笔记

wxchong 2024-06-19 22:26:39 开源技术 29 ℃ 0 评论

一 、简介 

Flyway 是一款开源的数据库版本管理工具。它可以很方便的在命令行中使用,或者在Java应用程序中引入,用于管理我们的数据库版本。

二、解决改下场景的问题

  1. 自己写的SQL忘了在所有环境执行。
  2. 别人写的SQL我们不能确定是否都在所有环境执行过了。
  3. 有人修改了已经执行过的SQL,期望再次执行。
  4. 需要新增环境做数据迁移。
  5. 每次发版需要手动控制先发DB版本,再发布应用版本。

三、flyway工作流程如下:

项目启动,应用程序完成数据库连接池的建立后,Flyway自动运行。

初次使用时,flyway会创建一个 flyway_schema_history 表,用于记录sql执行记录。

Flyway会扫描项目指定路径下(默认是 classpath:db/migration )的所有sql脚本,与 flyway_schema_history 表脚本记录进行比对。如果数据库记录执行过的脚本记录,与项目中的sql脚本不一致,Flyway会报错并停止项目执行。

如果校验通过,则根据表中的sql记录最大版本号,忽略所有版本号不大于该版本的脚本。再按照版本号从小到大,逐个执行其余脚本。

四、flyway的使用

1、引入依赖

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

2、添加相关配置

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

3、创建文件夹,需要在resource目录下建立文件夹 db/migration,或是根据上边配置中的路径创建相应的目录。

4、添加要运行的SQL脚本

SQL脚本命名规则:

仅需要被执行一次的SQL命名以大写的"V"开头,

V+版本号(版本号的数字间以”.“或”_“分隔开)+双下划线(用来分隔版本号和描述)+文件描述+后缀名。

例如: V2.00__create_flow.sql。

可重复运行的SQL,则以大写的“R”开头,后面再以两个下划线分割,其后跟文件名称,最后以.sql结尾。(不推荐使用)比如: R__truncate_user_dml.sql 。

其中,V开头的SQL执行优先级要比R开头的SQL优先级高。

创建完成后,目录应如下所示:

5、启动项目,查看数据库进行验证


sql脚本中的语句正常运行了就OK。


配置说明

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

Tags:

本文暂时没有评论,来添加一个吧(●'◡'●)

欢迎 发表评论:

最近发表
标签列表