如何在 Go 中安全执行多语句 SQL 脚本(含文件与字符串方式)

go 的 `database/sql` 标准库不支持单次 `exec()` 执行含多个分号的 sql 脚本,需手动拆分语句并借助事务批量执行;推荐使用专业迁移工具(如 goose 或 rambler)实现可维护、可回滚的数据库初始化。

在 Go 应用安装或初始化阶段,常需执行一整套 DDL(建表)和 DML(初始化数据)SQL 脚本。但直接将多条语句拼接为一个字符串(如 CREATE TABLE ...; INSERT INTO ...;)并调用 db.Exec(sqlStr) 会触发错误:

pq: cannot insert multiple commands into a prepared statement

该限制并非 PostgreSQL 驱动特有,而是 Go 标准库 database/sql 的底层设计决定:Exec() 和 Query() 均只接受单条 SQL 语句,不支持客户端侧的多语句批处理(类似 MySQL 的 multiStatements=true 参数在 pq 中不可用)。

✅ 正确做法:事务内逐条执行(推荐基础方案)

最稳妥、可控的方式是:

  1. 启动事务(确保原子性);
  2. 按分号(;)安全切分 SQL 字符串;
  3. 过滤空行与注释;
  4. 逐条 tx.Exec();
  5. 全部成功后提交,任一失败则回滚。

以下为生产就绪的实现示例(已处理常见边界):

import (
    "database/sql"
    "strings"
    "unicode"
)

func executeSQLScript(db *sql.DB, script string) error {
    tx, err := db.Begin()
    if err != nil {
        return err
    }
    defer func() {
        if err != nil {
            tx.Rollback()
        }
    }()

    // 按分号分割,保留跨行语句(如带换行的字符串字面量)
    statements := splitSQLStatements(script)

    for i, stmt := range statements {
        stmt = strings.TrimSpace(stmt)
        if stmt == "" || strings.HasPrefix(stmt, "--") || strings.HasPrefix(stmt, "/*") {
            continue // 跳过空行和单行/多行注释
        }

        _, err = tx.Exec(stmt)
        if err != nil {
            return &scriptExecutionError{
                StatementIndex: i + 1,
                Statement:      stmt[:min(len(stmt), 100)] + "...",
                Err:            err,
            }
        }
    }

    return tx.Commit()
}

// 简化版语句分割(适用于无嵌套分号的常规脚本)
func splitSQLStatements(sql string) []string {
    var parts []string
    var inQuote bool
    var quoteChar byte
    var start int

    for i := 0; i < len(sql); i++ {
        c := sql[i]
        switch {
        case !inQuote && (c == '"' || c == '\'' || c == '`'):
            inQuote = true
            quoteChar = c
            continue
        case inQuote && c == quoteChar:
            inQuote = false
            continue
        case !inQuote && c == ';' && (i == len(sql)-1 || unicode.IsSpace(rune(sql[i+1]))):
            parts = append(parts, sql[start:i])
            start = i + 1
        }
    }
    if start < len(sql) {
        parts = append(parts, sql[start:])
    }
    return pa

rts } type scriptExecutionError struct { StatementIndex int Statement string Err error } func (e *scriptExecutionError) Error() string { return "failed to execute SQL statement #" + fmt.Sprintf("%d: %s: %v", e.StatementIndex, e.Statement, e.Err) }
⚠️ 注意事项: 不要简单 strings.Split(sql, ";") —— 会错误切割字符串字面量内的分号(如 'foo;bar');上例中 splitSQLStatements 已规避此问题。 始终使用事务:避免部分语句成功导致数据库处于不一致状态。 显式跳过注释:PostgreSQL 支持 -- 和 /* */ 注释,需预处理。 添加错误上下文:记录失败语句序号与片段,便于调试。

? 进阶方案:采用 Schema Migration 工具

对于中大型项目,硬编码 SQL 字符串或临时脚本难以维护、无法版本控制、缺乏回滚能力。此时应引入专业迁移工具:

工具 特点
goose 功能完备,支持 Go/SQL 迁移、版本管理、up/down、CLI 友好,社区活跃。
rambler 轻量纯 SQL 方案,基于文件名语义排序(001_init.sql, 002_add_index.sql),易集成 CI。

使用 goose 示例:

# 初始化迁移目录
goose create init sql

# 编辑生成的 20250501120000_init.sql
# 写入你的 DDL/DML

# 执行迁移
goose postgres "user=... dbname=..." up

这类工具天然解决:语句分割、事务封装、幂等性、版本追踪、回滚支持——远超手写脚本的鲁棒性。

总结

  • Go 原生不支持多语句 SQL 执行,这是 database/sql 的明确限制,与驱动无关;
  • 手动拆分 + 事务执行是轻量级场景的可靠解法,但需谨慎处理语法边界;
  • 长期建议统一使用迁移工具(如 goose),将数据库变更纳入工程化流程,保障可重复部署与团队协作效率。