解决sql-migrate中PostgreSQL函数迁移的语法解析问题

在使用sql-migrate进行数据库迁移时，当迁移脚本中包含PostgreSQL函数定义时，可能会遇到"unterminated dollar-quoted string"的错误。这个问题通常发生在函数体使用$$符号作为分隔符的情况下。

问题现象

当执行包含PostgreSQL函数定义的迁移脚本时，sql-migrate会报错提示"unterminated dollar-quoted string"。这种错误特别容易出现在函数体使用PL/pgSQL语法，并且使用$$符号作为分隔符的情况下。

问题原因

sql-migrate默认会将SQL语句按分号(;)分割执行。当遇到函数定义时，函数体内可能包含多个分号，这会导致解析器错误地将函数体内的分号识别为语句结束符，从而中断了函数定义的完整性。

解决方案

sql-migrate提供了特殊的注释指令来处理这种情况：

1. -- +migrate StatementBegin - 标记一个语句块的开始
2. -- +migrate StatementEnd - 标记一个语句块的结束

在这两个标记之间的所有内容都会被当作一个完整的语句执行，不会被分号分割。

实际应用示例

对于包含PostgreSQL函数定义的迁移脚本，应该这样编写：

-- +migrate Up

-- +migrate StatementBegin
CREATE FUNCTION notify_event() RETURNS trigger
    LANGUAGE plpgsql
    AS $$
    DECLARE
        object json;
        notification json;
    BEGIN
        -- 函数逻辑
        RETURN NULL;
    END;
    $$;
-- +migrate StatementEnd

-- +migrate Down

最佳实践

1. 对于所有包含函数、存储过程或复杂PL/pgSQL代码的迁移脚本，都应该使用StatementBegin/StatementEnd标记
2. 保持$$符号的缩进一致，提高代码可读性
3. 在函数定义结束后确保有明确的分号
4. 在Down迁移中同样使用这些标记来确保回滚操作的正确性

通过这种方式，可以确保sql-migrate正确解析和执行包含复杂SQL结构的迁移脚本，避免因语法解析问题导致的迁移失败。