使用Goose实现多Schema数据库迁移的最佳实践

在数据库迁移工具Goose的实际应用中，开发者经常会遇到需要为多个Schema创建相同表结构的场景。本文将深入探讨如何利用Goose高效地实现这一需求。

多Schema迁移的挑战

在数据库设计中，有时我们需要为不同的租户或业务单元创建独立的Schema，每个Schema包含相同的表结构。传统做法是为每个Schema单独编写迁移脚本，但这会导致代码重复和维护困难。

Goose的解决方案

Goose支持在迁移文件中执行复杂的SQL语句，我们可以利用PostgreSQL的PL/pgSQL语言特性，通过动态SQL实现批量Schema和表的创建。

实现原理

核心思路是使用PostgreSQL的DO块执行匿名代码，结合循环和动态SQL生成技术：

1. 使用FOR循环遍历需要创建的Schema编号
2. 通过format函数动态生成Schema名称
3. 使用EXECUTE执行动态生成的DDL语句

完整迁移示例

-- +goose Up
-- +goose StatementBegin
DO $$
DECLARE
    schema_name text;
BEGIN
    -- 循环创建schema_1到schema_3
    FOR i IN 1..3 LOOP
        schema_name := 'schema_' || i;

        -- 创建Schema（如果不存在）
        EXECUTE format('CREATE SCHEMA IF NOT EXISTS %I', schema_name);

        -- 在Schema中创建表
        EXECUTE format('
            CREATE TABLE IF NOT EXISTS %I.table_1 (
                id TEXT PRIMARY KEY,
                name TEXT NOT NULL
            )', schema_name);

        -- 可以继续添加更多表结构
    END LOOP;
END;
$$;
-- +goose StatementEnd

-- +goose Down
-- +goose StatementBegin
DO $$
DECLARE
    schema_name text;
BEGIN
    -- 循环删除schema_1到schema_3（级联删除所有对象）
    FOR i IN 1..3 LOOP
        schema_name := 'schema_' || i;
        EXECUTE format('DROP SCHEMA IF EXISTS %I CASCADE', schema_name);
    END LOOP;
END;
$$;
-- +goose StatementEnd

技术优势

1. 代码简洁：一个迁移文件管理所有Schema的创建
2. 易于维护：修改表结构只需修改一处
3. 执行高效：数据库层面完成所有操作，减少网络往返
4. 事务安全：整个操作在一个事务中执行

实际应用建议

1. Schema命名：可以根据业务需求动态生成Schema名称
2. 批量大小：对于大量Schema，考虑分批处理以避免长事务
3. 错误处理：可以在PL/pgSQL中添加异常处理逻辑
4. 环境适配：通过Goose的环境变量控制Schema数量

这种方案特别适合多租户SaaS应用、分片数据库等场景，既能保持数据隔离，又能简化迁移管理。