Flyway-数据库迁移工具

于 2021-08-18 16:34:15 发布
阅读量932 收藏 3
点赞数
分类专栏： flyway 文章标签： java maven 数据库开发
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/DK_Allen/article/details/119783442
版权

1.摘要

当我们的应用升级时往往会伴随着数据库表结构的升级，此时就需要迁移数据库的表结构。一般我们会使用工具或者脚本来实现，手动操作毕竟有一定风险，要是能在应用启动时自动升级数据库表结构就好了！Flyway正是这么一款工具，通过Flyway和SpringBoot结合使用，在应用启动时就可以自动升级数据库表结构，非常方便，推荐给大家！

2.Flyway简介

Flyway是一款数据库迁移工具，它让数据库迁移变得更加简单。它能像Git一样对数据库进行版本控制，支持命令行工具、Maven插件、第三方工具（比如SpringBoot）等多种使用方式。

Flyway具有如下特点：

  • 简单：使用和学习简单，通过不同版本的SQL脚本实现数据库迁移。
  • 专业：专注于数据库迁移功能，你无需担心有任何问题。
  • 功能强大：支持多种数据库，拥有大量的第三方工具，支持CI/DI。

3.相关概念

3.1 工作原理

使用Flyway时我们需要编写好数据库迁移的SQL脚本，比如 V1__Initial_Setup.sql中初始化了三种表，V2__First_Changes.sql中又新增了两种表。Flyway会创建flyway_schema_history表，用于存储这些SQL脚本的执行情况，从而对数据库进行版本控制。当我们使用Flyway进行数据库迁移时，Flyway会根据flyway_schema_history表中的记录，自行决定需要执行哪些SQL脚本，从而实现数据库迁移。

3.2 脚本命名规范

在创建Flyway的SQL脚本时，有些命名规范需要遵守，这些命名规范决定了Flyway执行脚本的顺序和方式，可以先参考下面的示意图。

为了能被Flyway正确执行，SQL迁移脚本需要遵循如下规范：

  • Prefix（前缀）：V表示有版本号的数据库迁移，U表示一些数据库版本的回滚，R表示可重复执行的数据库迁移；
  • Version（版本号）：Flyway会按照版本号的大小顺序来执行数据库迁移脚本；
  • Separator（分隔符）：命名时使用双下划线分隔符；
  • Description（描述）：用于描述该迁移脚本的具体操作说明；
  • Suffix（后缀）：表示.sql文件。

3.3 相关命令

  • migrate：数据库迁移命令，会根据设置好的SQL脚本直接将数据库表升级至最新版本。
  • clean：删除数据库中所有的表，千万别在生产环境上使用。
  • info：打印所有关于数据库迁移的详细信息和状态信息。
  • validate：验证数据库迁移是否可用。
  • undo：对数据库迁移进行回滚操作。
  • baseline：以现有数据库为基准，创建flyway_schema_history表，大于基准版本的数据库迁移才会被应用。
  • repair：修复flyway_schema_history表。

3.4 命令行工具

使用Flyway实现数据迁移有多种方式，我们先通过命令行工具的方法来体验下Flyway的使用。

  • 下载完成后进行解压，解压完成后目录结构如下；

  • 修改Flyway的配置文件/conf/flyway.conf，修改下数据库配置即可；
flyway.url=jdbc:mysql://localhost:3306/flyway?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
flyway.user=root
flyway.password=root
  • 在/sql目录下添加SQL执行脚本，这里添加创建ums_admin表的执行脚本
V1.0.1__Create_ums_admin_table.sql；
CREATE TABLE ums_admin
(
id          bigint(20) NOT NULL AUTO_INCREMENT,
username    varchar(64)  DEFAULT NULL,
password    varchar(64)  DEFAULT NULL,
icon        varchar(500) DEFAULT NULL COMMENT '头像',
email       varchar(100) DEFAULT NULL COMMENT '邮箱',
nick_name   varchar(200) DEFAULT NULL COMMENT '昵称',
note        varchar(500) DEFAULT NULL COMMENT '备注信息',
create_time datetime     DEFAULT NULL COMMENT '创建时间',
login_time  datetime     DEFAULT NULL COMMENT '最后登录时间',
status      int(1)       DEFAULT '1' COMMENT '帐号启用状态：0->禁用；1->启用',
PRIMARY KEY (id)
) ENGINE = InnoDB
AUTO_INCREMENT = 8
DEFAULT CHARSET = utf8 COMMENT ='后台用户表';
  • 使用flyway migrate命令进行数据迁移，此时我们会发现需要先使用flyway baseline命令创建保存迁移记录的表flyway_schema_history才行；

  • 先使用flyway baseline命令，再使用flyway migrate命令，命令行会输出执行成功的信息；

  • 在\sql目录下添加SQL执行脚本，给ums_admin表添加一些数据，执行脚本为
V1.0.2__Add_ums_admin.sql；
INSERT INTO ums_admin (username, PASSWORD, email, nick_name, STATUS)
VALUES ('test', '123456', 'test@qq.com', '测试账号', 1);
INSERT INTO ums_admin (username, PASSWORD, email, nick_name, STATUS)
VALUES ('macro', '123456', 'macro@qq.com', '普通账号', 1);
INSERT INTO ums_admin (username, PASSWORD, email, nick_name, STATUS)
VALUES ('andy', '123456', 'andy@qq.com', '普通账号', 1);
  • 我们可以使用flyway info命令查看flyway_schema_history表中的数据迁移记录，可以发现1.0.2版本的更新还处于Pending状态，使用flyway migrate命令后变为Success；

  • 我们可以创建可重复执行的SQL脚本，通常可以用来创建视图、存储过程、函数等，比如基于ums_admin表创建一个视图，执行脚本为R__Ums_admin_view.sql;
CREATE
OR REPLACE VIEW ums_admin_view AS
SELECT username,
PASSWORD,
email
FROM ums_admin;

  • 使用flyway migrate命令可以重复执行（当R开头的脚本有变更时），该脚本会在所有V开头的脚本执行完成后执行；

  • Flyway的回滚机制需要依赖SQL脚本，这里创建U1.0.1__Create_ums_admin_table.sql和U1.0.2__Add_ums_admin.sql两个回滚脚本；
DROP TABLE ums_admin

DELETE FROM ums_admin;
  • 使用flyway undo命令可以执行回滚，很遗憾的是社区版本不支持回滚，看样子数据库升级之前还是得通过工具做好备份才行！

3.5 Maven插件

Flyway也提供了Maven插件，插件所支持功能与命令行工具基本一致。

  • 想要在Maven项目通过插件使用Flyway，首先需要在pom.xml中添加Flyway的插件并配置好数据库连接信息；
org.flywaydb flyway-maven-plugin 7.3.2              
jdbc:mysql://localhost:3306/flyway?serverTimezone=Asia/Shanghai root root
mysql mysql-connector-java 8.0.15

  • 在resouce目录下创建db\migration目录，将数据库升级使用的SQL脚本放入进去；

  • Flyway的Maven插件支持如下几种命令；

  • 双击flyway:info命令使用，输出如下内容，此方式与命令行工具使用基本没啥区别。
[INFO] --- flyway-maven-plugin:7.3.2:info (default-cli) @ mall-tiny-flyway ---
[INFO] Flyway Community Edition 7.3.2 by Redgate
[INFO] Database: jdbc:mysql://localhost:3306/flyway (MySQL 5.7)
[INFO] Schema version: 1.0.2
[INFO]
[INFO] +------------+---------+------------------------+----------+---------------------+----------+
| Category   | Version | Description            | Type     | Installed On        | State    |
+------------+---------+------------------------+----------+---------------------+----------+
|            | 1       | << Flyway Baseline >>  | BASELINE | 2020-12-24 11:17:35 | Baseline |
| Versioned  | 1.0.1   | Create ums admin table | SQL      | 2020-12-24 11:17:42 | Success  |
| Versioned  | 1.0.2   | Add ums admin          | SQL      | 2020-12-24 11:33:40 | Success  |
| Repeatable |         | Ums admin view         | SQL      | 2020-12-24 11:33:40 | Success  |
+------------+---------+------------------------+----------+---------------------+----------+
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 9.076 s
[INFO] Finished at: 2020-12-24T14:28:16+08:00
[INFO] Final Memory: 28M/286M
[INFO] ------------------------------------------------------------------------
Process finished with exit code 0

4.本地试运行

4.1 application.properties

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

4.2 pom.xml

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

<plugin>
  <groupId>org.flywaydb</groupId>
  <artifactId>flyway-maven-plugin</artifactId>
</plugin>

4.3 resources

添加需要执行的SQL（按照上述命名规范），例如

INSERT INTO `XXXXXXXXXXXXXXX`.`t_user_vaccination`(`id`, `user_id`, `actual_name`, `identity_number`, `mobile`, `type`, `street_name`, `collective_name`, `detailed_address`, `building_number`, `unit_number`, `house_number`, `member_number`, `created_by`, `created_date`, `last_modified_by`, `last_modified_date`, `remarks`, `del_flag`, `version`, `disabled_date`)
VALUES (5, 21080603, '张三', '22072319960403061X', '13666666666', 1, '街道名称', '所在集体名称', '所在集体详细地址', '所在集体楼号', '所在楼单元号', '所在单元室号', 1, '11005304', '2021-08-06 16:36:25', '11005304', '2021-08-06 14:10:42', NULL, 1, 0, NULL);

4.4 创建flyway_schema_history

CREATE TABLE `XXXXXXXXXXX`.`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 NOT NULL DEFAULT CURRENT_TIMESTAMP,
    `execution_time` INT NOT NULL,
    `success` BOOL NOT NULL,
    CONSTRAINT `flyway_schema_history_pk` PRIMARY KEY (`installed_rank`)
) ENGINE=InnoDB

4.5 flyway_schema_history记录

本地启动后，执行SQL，并生成记录，查看数据。

SLD_Allen
关注
  • 0
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
博客
sysbench 性能测试
12-13 2239
sysbench 性能测试
博客
canal-MySQL数据库增量日志解析
12-13 331
canal-MySQL数据库增量日志解析
博客
log4j2漏洞修复
12-13 1477
log4j2漏洞修复
博客
MySQL常用监控指标及监控方法
12-10 2430
MySQL常用监控指标及监控方法
博客
Mysql测评和加固
12-10 1430
Mysql测评和加固
博客
MySQL 优化实施方案
12-10 177
MySQL 优化实施方案
博客
MySQL性能工具
12-10 983
MySQL性能工具
博客
【mykit-data】 数据库同步工具
12-10 1184
【mykit-data】 数据库同步工具
博客
【Bytebase】数据库结构变更和版本管理
12-10 1257
【Bytebase】数据库结构变更和版本管理
博客
UReport2初体验
08-18 2327
1.产品介绍UReport2是一款纯Java的高性能报表引擎。 其优点在于：是开源的，基于Apache-2.0开源协议；其次，在项目中直接集成网页端报表设计器，灵活、方便、易维护和管理；另外，可以实现任意复杂的中国式报表。本文档介绍Spring Boot集成UReport2报表引擎方案，旨在详解从0到1的具体实现步骤，为后续高阶方案提供知识基础及实践经验。2.工程搭建2.1 新建Maven项目推荐使用Spring Initializr创建，能自动添加很多依赖，如下所示：选择S

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值