Liquibase 全标签使用样例

发现的坑

部分数据库在创建表时事务会失效

Mysql和Oracle在一个事务中创建表时，即使事务失败回滚，表也不会删除，导致再跑changelog时出现表名冲突报错。

而PostgreSQL可以正常删除表。

可以在创建表的时候写好rollback：

<changeSet id="t13" author="vudsen">
    <createTable tableName="table13">
        <column name="col1" type="${type.int}"/>
        <column name="col2" type="${type.int}"/>
        <column name="col3" type="${type.int}"/>
    </createTable>
    <rollback>
        <dropTable tableName="table13"/>
    </rollback>
</changeSet>
xml

然后添加listener：

public class ChangeExecListenerImpl implements ChangeExecListener {

     @Override
    public void runFailed(ChangeSet changeSet, DatabaseChangeLog databaseChangeLog, Database database, Exception exception) {
        List<Change> changes = changeSet.getChanges();
        String shortName = database.getShortName();
        if ("mysql".equals(shortName) || "oracle".equals(shortName)) {
            boolean shouldRollbackNow = false;
            for (Change change : changes) {
                if (change instanceof CreateTableChange) {
                    shouldRollbackNow = true;
                    break;
                }
            }
            if (!shouldRollbackNow) {
                return;
            }
            log.info("正在执行回滚逻辑");
            RollbackContainer rollback = changeSet.getRollback();
            try {
                database.setAutoCommit(false);
                database.rollback();
                for (Change change : rollback.getChanges()) {
                    database.executeStatements(change, databaseChangeLog, Collections.emptyList());
                }
                database.commit();
            } catch (LiquibaseException e) {
                try {
                    database.rollback();
                } catch (DatabaseException ex) {
                    throw new RuntimeException(ex);
                }
                throw new RuntimeException(e);
            }
        }
    }
   
}
java

语法提示有某个属性，但是文档没有

出现这种情况应该是schema的版本和文档不一致：

xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-4.9.xsd
text

只要把后面的版本和依赖版本配置成一样的就好了。

changeSet

tagDatabase

用于给Changelog标记一个版本号，便于回滚时使用：

<changeSet  author="liquibase-docs"  id="tagDatabase-example">  
    <tagDatabase  tag="version_1.3"/>  
</changeSet>
xml

回滚时有一个根据tag来回滚的方法，没有根据changeSet id回滚的方法。

createTable

column

备注：type可以直接使用如下值，会被自动转换成对应数据库的数据结构：

• BIGINT
• BLOB
• BOOLEAN
• CLOB
• CURRENCY
• DATE
• DATETIME
• TIME
• UUID

也可以直接使用java类，如：

• java.sql.Types.TIMESTAMP
• java.sql.Types.VARCHAR(255)

constraints

createIndex

createProcedure

存储过程只能通过手写sql来创建：createProcedure (liquibase.com)

createView

视图只能通过手写sql来创建：createView (liquibase.com)

createSequence

createSequence (liquibase.com)

创建一个序列。MySQL不支持，PostgreSQL和Oralce支持。

addColumn

addForeignKeyConstraint

addPrimaryKey

addDefaultValue

addUniqueConstraint

addLookupTable

功能和添加外键相同，但是这个标签会自动把数据同步过去:

<changeSet id="t11" author="vudsen">
    <createTable tableName="table9">
        <column name="col1" type="${type.int}"/>
        <column name="col2" type="${type.int}"/>
    </createTable>
    <insert tableName="table9">
        <column name="col1" value="1"/>
        <column name="col2" value="1"/>
    </insert>
    <addLookupTable existingTableName="table9" existingColumnName="col1" newTableName="t11_lut" newColumnName="col1_lut" newColumnDataType="${type.int}"/>
</changeSet>
xml

在运行后，会给table9创建一个FK_TABLE9_T11_LUT的外键，指向表t11_lut(col1_lut)，同时，t11_lut中也会有table9的数据。

Mysql、PostgreSQL和Oracle都支持。

addAutoIncrement

Oracle不支持，MySQL和PostgreSQL支持

addNotNullConstraint

insert & update & delete

update使用示例：

<changeSet id="t13" author="vudsen">
    <createTable tableName="table13">
        <column name="col1" type="${type.int}"/>
        <column name="col2" type="${type.int}"/>
        <column name="col3" type="${type.int}"/>
    </createTable>
    <insert tableName="table13" catalogName="">
        <column name="col1" value="1"/>
        <column name="col2" value="2"/>
        <column name="col3" value="3"/>
    </insert>
    <update tableName="table13">
        <column name="col1" valueComputed="col1 + 1"/>
        <where>col1 = :value AND col3 = :value</where>
        <whereParams>
            <param valueNumeric="1"/>
            <param valueNumeric="3"/>
        </whereParams>
    </update>
    <rollback>
        <dropTable tableName="table13"/>
    </rollback>
</changeSet>
xml

whereParams中只能在where用:value来对应，whereParams里的name没有用处。

推荐参数都在whereParams里写，liquibase会自动转换日期等类型（mysql日期可以直接写字符串，oracle需要借助函数）

dropTable

dropAllForeignKeyConstraints

如果要删除单个外键可以用dropForeignKeyConstraint

dropColumn

dropDefaultValue

dropIndex

dropForeignKeyConstraint

dropNotNullConstraint

dropPrimaryKey

所有数据库均可使用，但是在MySQL中无法删除自动增长的主键，PostgreSQL和Oracle可以直接删除。

dropUniqueConstraint

dropProcedure

未测试

dropSequence

未测试

dropView

未测试

modifyDataType

修改前后的数据类型不同，在不同的数据库可能报错，例如从int -> varchar，mysql和PostgreSQL在有数据的情况下不会报错，而oracle会报错。

但是对于varchar -> varchar，在oracle中即使有数据也不会报错。

renameColumn

renameTable

renameSequence

未测试

renameView

未测试

setColumnRemarks

setTableRemarks

mergeColumns

合并两个列，合并后原来的两个列会消失。

preConditions

以下标签全可用：

• tableIsEmpty：是否为空表
• tableExists：表是否存在
• columnExists：列是否存在
• primaryKeyExists：主键是否存在
• rowCount：计算有几行
• foreignKeyConstraintExists：外键是否存在
• indexExists：索引是否存在
• uniqueConstraintExists：唯一约束是否存在

未测试：

• viewExists：视图是否存在