如何在Supabase迁移文件中引用本地SQL文件？

问题原因 #

\i是psql客户端的专属元命令，并非PostgreSQL支持的标准SQL语法。Supabase CLI执行迁移时，会直接将SQL语句发送给PostgreSQL服务器执行，不会经过psql解析，因此无法识别\i，导致语法错误。

可行解决方案 #

方案1：编写脚本自动合并SQL内容（推荐） #

通过脚本将外部SQL文件的内容注入到迁移文件中，避免手动复制粘贴，同时兼容Supabase迁移机制。

示例步骤：

1. 在迁移文件some_timestamp_migration.sql中添加标记注释：

-- 引入自定义类型
-- INSERT_CUSTOM_TYPE_HERE

-- 后续迁移逻辑
CREATE TABLE example (
  id UUID PRIMARY KEY,
  status custom_type NOT NULL
);

2. 创建Shell脚本（如merge-sql.sh）实现替换逻辑：

#!/bin/bash
# 替换迁移文件中的标记为custom_type.sql的内容
sed -i '' '/-- INSERT_CUSTOM_TYPE_HERE/r db/supabase/types/custom_type.sql' db/supabase/migrations/some_timestamp_migration.sql

3. 执行脚本后运行迁移：

sh merge-sql.sh
supabase migration up

注：Windows环境可使用PowerShell脚本或Windows版sed实现类似逻辑

方案2：使用PostgreSQL的pg_read_file函数（需注意权限） #

利用PostgreSQL内置函数读取服务器端SQL文件内容并执行，本地开发环境通常满足权限要求。

示例迁移代码：

DO $$
DECLARE
  sql_content TEXT;
BEGIN
  -- 路径为Supabase容器内的文件路径，本地开发可使用映射后的绝对路径
  sql_content := pg_read_file('/app/db/supabase/types/custom_type.sql');
  EXECUTE sql_content;
END $$;

注意：生产环境使用需谨慎，需确保文件权限安全，避免注入风险

方案3：通过psql预处理迁移文件 #

先用psql解析包含\i的迁移文件，生成纯SQL后再执行迁移：

# 用psql处理元命令，输出纯SQL到临时文件
psql -d "$(supabase status --url)" -f db/supabase/migrations/some_timestamp_migration.sql > temp_migration.sql
# 将临时文件作为迁移文件执行（需确保文件名符合迁移时间戳格式）
supabase migration up --file temp_migration.sql

此方法需注意临时文件的命名规范，避免干扰迁移历史

内容的提问来源于stack exchange，提问作者Jay6742319