Liquibase 中 endDelimiter 参数在 PostgreSQL 函数定义中的使用问题分析

问题背景

Liquibase 是一款流行的数据库变更管理工具，它允许开发者通过声明式的方式管理数据库变更。在 Liquibase 4.29.2 版本中，用户报告了一个关于 endDelimiter 参数的问题，特别是在 PostgreSQL 函数定义中使用 $$ 作为分隔符时出现了解析错误。

问题现象

用户在 PostgreSQL 数据库中使用 Liquibase 部署包含 PL/pgSQL 函数的变更集时，遇到了语法错误。具体表现为：

<sql endDelimiter="$$">
    create function foo() returns trigger AS $$
    begin
    ...
    end;
    $$ language plpgsql;
</sql>

执行时会报错：

ERROR: syntax error at end of input [Failed SQL: (0) create function A() returns trigger AS]

技术分析

历史行为

在 Liquibase 4.27.0 及更早版本中，endDelimiter="$$" 能够正确解析 PostgreSQL 函数定义。整个函数体被当作一个完整的语句执行。

4.28.0 版本后的变化

从 Liquibase 4.28.0 开始，解析器将 $$ 视为语句分隔符，导致函数定义被拆分成多个部分：

1. 第一部分：

create function foo() returns trigger AS

2. 第二部分：

begin
...
end;

3. 第三部分：

language plpgsql;

这种拆分导致第一个语句不完整，从而引发语法错误。

解决方案

推荐方案

使用不冲突的分隔符替代 $$，例如 $END$：

<sql endDelimiter="$END$">
    create function foo() returns trigger AS $$
    begin
    ...
    end;
    $$ language plpgsql;
$END$

其他注意事项

1. 向后兼容性：这个变化影响了现有使用 $$ 作为分隔符的变更集，需要开发者手动更新。

2. 文档建议：官方文档应明确说明在 PostgreSQL 函数定义中使用 endDelimiter 时的最佳实践。

3. 测试策略：升级 Liquibase 版本后，应特别测试包含函数定义的变更集。

技术原理

Liquibase 的 SQL 解析器在处理 endDelimiter 参数时，会扫描整个 SQL 内容寻找匹配的分隔符。当使用 $$ 作为分隔符时，它与 PostgreSQL 函数体标记冲突，导致解析器错误地将函数体内的 $$ 也识别为语句分隔符。

最佳实践建议

1. 避免在 PostgreSQL 函数定义中使用 $$ 作为 Liquibase 的 endDelimiter。

2. 考虑使用更独特的分隔符，如 $END$ 或 //，减少与 SQL 内容冲突的可能性。

3. 对于复杂的 SQL 对象（如函数、存储过程），建议将其放在单独的文件中，通过 <sqlFile> 标签引用。

4. 升级 Liquibase 版本时，应全面测试数据库变更脚本，特别是包含复杂 SQL 对象的部分。

总结

Liquibase 4.28.0 版本对 endDelimiter 的处理逻辑进行了改进，这导致了一些向后兼容性问题。开发者需要了解这一变化，并相应调整他们的变更集定义。通过使用不冲突的分隔符和遵循最佳实践，可以确保数据库变更的顺利执行。