FlyWay简单入门

Chamberlan
2,440 阅读4分钟

Flyway使用说明

前言

Flyway 是一款开源的数据库版本管理工具，它更倾向于规约优于配置的方式。Flyway 可以独立于应用实现管理并跟踪数据库变更，支持数据库版本自动升级，并且有一套默认的规约，不需要复杂的配置，Migrations 可以写成 SQL 脚本，也可以写在 Java 代码中，不仅支持 Command Line 和 Java API，还支持 Build 构建工具和 Spring Boot 等，同时在分布式环境下能够安全可靠地升级数据库，同时也支持失败恢复等。

运行原理

当 Flyway 连接数据库中的 schema 后，会先检查是否已存在 flyway_schema_history 表，如果没有则创建。该表用于跟踪数据库的状态，如数据迁移的版本，迁移成功状态等信息。

当 flyway_schema_history 存在后，Flyway 会扫描文件系统或应用中的 classpath 目录的数据迁移文件，然后根据它们的版本号进行按序迁移，如下图：

img

核心

Flyway最核心的就是用于记录所有版本演化和状态的MetaData表，Flyway首次启动会创建默认名为SCHEMA_VERSION的元素局表。 表中保存了版本，描述，要执行的sql脚本等；

sql脚本的格式：V+版本号 +双下划线+秒速+结束符

例如：V1__INIT_DATABASE.sql

上面的V 是默认值， 可以通过

flyway.sql-migration-prefix来指定前缀 ，

Migrate

Migrate是指把数据Schema迁移到最新版本，在Migrate时会检查MetaData元数据表，如果不存在就创建MetaData表，MetaData用于记录数据库历史变更等信息；

Migrate会扫描指定文件系统或者classpath下的Migrations。会与MetaData中的记录进行对比，进行版本升级；

Clean

清除掉对应数据库Schema中所有的对象，包括表结构，视图，存储过程等，clean操作在dev 和 test阶段很好用；

Info

用于打印所有的Migrations的详细和状态信息，也是通过MetaData和Migrations完成的，可以快速定位当前的数据库版本；

validate

验证以及apply的Migrations是否有变更，默认开启的；原理是对比MetaData表与本地Migrations的checkNum值，如果值相同则验证通过，否则失败。

BaseLine

对已经存在数据库Schema结构的数据库一种解决方案。实现在非空数据库新建MetaData表，并把Migrations应用到该数据库；也可以应用到已有表结构的数据库中也可以实现添加Metadata表。

repair

repair操作能够修复metaData表，该操作在metadata出现错误时很有用

用途：

1）：移除失败的Migration记录，只针对不支持DDL事务的数据库

flyway与springboot集成

  • 引入flyway依赖
<dependency>
      <groupId>org.flywaydb</groupId>
      <artifactId>flyway-core</artifactId>
</dependency>

<plugin>
                <groupId>org.flywaydb</groupId>
                <artifactId>flyway-maven-plugin</artifactId>
                <version>5.0.3</version>
            </plugin>
  • 配置数据源信息
server:
  port: 8081
spring:
  datasource:
    name: qis_busi
    url: jdbc:mysql://localhost:3306/flyway?museUnicode=true&characterEncoding=utf-8&serverTimezone=UTC
    username: root
    password: 123456
    type: com.alibaba.druid.pool.DruidDataSource
    driver-class-name: com.mysql.jdbc.Driver
    filters: stat
    maxActive: 20
    initialSize: 1
    maxWait: 60000
    minIdle: 1
    timeBetweenEvictionRunsMillis: 60000
    minEvictableIdleTimeMillis: 300000
    validationQuery: select 'x'
    testWhileIdle: true
    testOnBorrow: false
    testOnReturn: false
    poolPreparedStatements: true
    maxOpenPreparedStatements: 20
  • 在classpath下新建db/migration文件夹，并创建sql脚本
CREATE TABLE person (
  id int(11) NOT NULL AUTO_INCREMENT,
  first varchar(100) NOT NULL,
  last varchar(100) NOT NULL,
  dateofbirth DATE DEFAULT null,
  placeofbirth varchar(100) not null,
  PRIMARY KEY (id)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

insert into person (first,last,dateofbirth,placeofbirth) values('zhangsan','KOC', STR_TO_DATE('02/10/1982', '%m/%d/%Y'),'Erzincan');


insert into person (first,last,dateofbirth,placeofbirth) values('lisi','KeeOC', STR_TO_DATE('05/10/1982', '%m/%d/%Y'),'Erzeeincan');
  • 启动springboot项目

1577172423227

  • 查看数据库

生成了flyway_schema_history表，这个版本默认是这个表。

注意事项

如果 flyway 不是项目初期引入，而是在数据库已有表的情况下引入时必须设置 baseline-on-migrate: true，设置该配置启动项目后，flyway 就会在数据库中创建 flyway_schema_history 表，并且会往该表中插入一条 version = 1 的建表记录，如果迁移数据有 V1__ 开头的文件，扫描文件会忽略该文件不执行迁移，进而可能引发其他迁移数据出错的问题。

如果不设置为true的话，则会对db/migration下的sql依次迁移

设置clean-on-validation-error: true的话如果校验报错则会删掉所以数据表重新迁移数据

如果已有flyway_schema_history表则不会插入version=1这条记录；

flyway:
    validate-on-migrate: true
    baseline-on-migrate: true

blog.csdn.net/AinGates/ar…

juejin.cn/post/684490…

avatar
文章
阅读
粉丝