数据库迁移工具之Liquibase

这片文章用于梳理项目中用到的Liquibase。

Liquibase是一种开源的数据库迁移工具(Database migration tool),官网上对它的描述是“source control of database”,即数据库的版本管理工具。常用的数据库迁移工具还有flyway,会在后续文章中总结。Liquibase支持各种主流数据库,如Mysql,PostgreSQL,DB2,Oracle,SQL server,H2,Hsql等。

如何在Spring Boot项目中使用Liquibase?

Step1. 在项目中引入Liquibase依赖。如下图build.gradle中声明liquibase-core依赖。

Step 2. 把changelog放在/db/changelog/db.changelog-master.yaml。/db/changelog/db.changelog-master.yaml是Spring Boot查找changelog的默认路径,Spring Boot启动时,会自动运行liquibase进行数据库迁移。同时也可以通过配置属性liquibase.change-log=<path/changelogFile>来自定义change log路径。

Liquibase的核心就是用changeLog文件来记录跟踪数据库更新。Liquibase支持的changeLog格式包括:XML,JSON,YAML和SQL。这里我们以XML为例,如下图所示,changeLog用‘databaseChangeLog’标签表示,可以包含多个changeSet.

Step 3. 定义changeSet。ID和Auther必填,其中ID可以是数字也可以是表义的字符串;其他信息包括Context,PreConditions,Sql和Rollback语句。上图中的change set用于创建Factory数据表。

Liquibase运行时会顺序读取change log中定义的change set,并基于change set的ID,author和change log文件路径查看该change set是否已经存在于“databasechangelog”数据表,存在代表已经执行过,则跳过该change set(除非runAlways置为true)。change set执行完成后,会基于ID,author和change log文件路径生成MD5值存储到“databasechangelog”数据表,用于防止change set在被执行后发生修改。如果change set在执行后被修改,那么Liquibase运行时会报错并停止数据库更新,以避免出现数据库状态与change log期待状态的不一致。

Liquibase最佳实践

1. 使用major release来组织change log。如db.changelog-1.0.xml;db.changelog-1.1.xml;db.changelog-2.0.xml。

2. 使用Master change log引用各个major release change log,引用顺序即为release顺序。如下图所示。

3. 每个change set仅包含单个数据库修改。因为liquibase把一个change set作为一个事务;而某些数据库支持statement自动提交,因此通常做法是一个change set仅包含一个数据库修改。

Liquibase的其他功能

1. 支持生成数据库更新文档,如下图所示,包括当前数据表结构,历次change log等信息。

2. 类似VCS的diff功能,Liquibase提供diff命令查看数据库的修改,尽管开发过程中每次修改都有change log,但是diff命令可以帮助我们比如在上线之前查看并确认数据库的修改。

3. 提供SQL Output模式。项目中有时并不希望Liquibase自动完成数据库更新,比如我们需要DBA审批等,那么Liquibase的SQL Output模式可以仅生成用于更新和回滚的SQL语句,而不会进行真正的更新。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,482评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,377评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,762评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,273评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,289评论 5 373
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,046评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,351评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,988评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,476评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,948评论 2 324
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,064评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,712评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,261评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,264评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,486评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,511评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,802评论 2 345

推荐阅读更多精彩内容