解决Goose在PostgreSQL函数中报告“未终止的美元引用字符串”错误

---

本文旨在解决使用goose工具创建包含内部分号的postgresql函数时，常见的“未终止的美元引用字符串”错误。该错误通常源于goose对复杂sql语句的默认解析行为。教程将详细介绍如何通过添加`-- +goose statementbegin`和`-- +goose statementend`注解来正确标记这些语句，确保数据库迁移工具能够正确处理并执行函数创建操作，从而避免`pq`库报告的解析错误。

1. 问题背景与错误现象

在使用Goose进行PostgreSQL数据库迁移时，开发者可能会遇到在创建复杂函数（特别是包含$BODY$或$$美元引用字符串且内部含有多个分号的函数）时，系统报告pq: unterminated dollar-quoted string at or near "$BODY$..."的错误。尽管相同的SQL语句在pgAdmin等数据库客户端中可以成功执行，但在通过Goose执行迁移时却失败。这表明问题并非出在SQL语句本身的语法错误，而是Goose或其底层数据库驱动（如lib/pq）在解析此类语句时存在特定的处理机制。

示例错误信息：

(pq: unterminated dollar-quoted string at or near "$BODY$
BEGIN
    LOOP
        -- first try to update the key
        UPDATE userslocations SET count = count+1 WHERE userid = user_id AND locationid = location_id;
"), quitting migration.

2. 错误根源分析

Goose作为一款Go语言的数据库迁移工具，在处理SQL迁移文件时，会尝试解析并拆分文件中的各个SQL语句。其默认的解析逻辑通常以分号（;）作为语句的终止符。然而，PostgreSQL函数体内部（特别是使用美元引用字符串$BODY$或$$定义的函数体）可以包含任意数量的分号，这些分号是函数逻辑的一部分，并非独立的SQL语句分隔符。

当Goose遇到一个包含内部分号的函数定义时，它可能会错误地将函数体内部的分号识别为语句的结束，从而导致它在不恰当的位置截断SQL语句。这种错误的截断使得传递给lib/pq驱动的SQL不再是一个完整的、语法正确的函数定义，进而导致lib/pq报告“未终止的美元引用字符串”错误，因为它无法找到匹配的美元引用结束符。

3. 解决方案：Goose的特殊注解

为了解决这一问题，Goose提供了特殊的SQL注解，允许开发者明确指示哪些SQL块应该被视为一个完整的、不可分割的语句。这些注解是：

• -- +goose StatementBegin
• -- +goose StatementEnd

通过在复杂SQL语句的开始和结束位置添加这两个注解，Goose会忽略语句内部的分号，将整个被注解的块作为一个单一的SQL命令发送给数据库驱动执行。

无限画

千库网旗下AI绘画创作平台

574 查看详情

4. 实施示例

以下是原始的PostgreSQL函数定义及其经过Goose注解修正后的版本。

原始问题代码：

   CREATE OR REPLACE FUNCTION add_userlocation(user_id INT, location_id INT) RETURNS VOID AS
   $BODY$
   BEGIN
       LOOP
           UPDATE userslocations SET count = count+1 WHERE userid = user_id AND locationid = location_id;
        IF found THEN
            RETURN;
        END IF;
        BEGIN
            INSERT INTO userslocations(userid,locationid, count) VALUES (user_id, location_id, 1);
               RETURN;
           EXCEPTION WHEN unique_violation THEN
        END;
       END LOOP;
   END;
   $BODY$
   LANGUAGE plpgsql;

使用Goose注解修正后的代码：

-- +goose StatementBegin
CREATE OR REPLACE FUNCTION add_userlocation(user_id INT, location_id INT) RETURNS VOID AS
$BODY$
BEGIN
    LOOP
        UPDATE userslocations SET count = count+1 WHERE userid = user_id AND locationid = location_id;
        IF found THEN
            RETURN;
        END IF;
        BEGIN
            INSERT INTO userslocations(userid,locationid, count) VALUES (user_id, location_id, 1);
            RETURN;
        EXCEPTION WHEN unique_violation THEN
        END;
    END LOOP;
END;
$BODY$
LANGUAGE plpgsql;
-- +goose StatementEnd

通过添加-- +goose StatementBegin和-- +goose StatementEnd，Goose现在能够正确识别整个函数定义为一个原子操作，避免了内部解析错误。

5. 注意事项与最佳实践

• 适用范围： 并非所有SQL语句都需要这些注解。只有当SQL语句内部包含Goose默认解析器可能误判为语句终止符（如分号）的字符，且这些字符实际上是语句逻辑的一部分时，才需要使用StatementBegin/StatementEnd。这主要发生在创建函数、存储过程、触发器等复杂数据库对象时。
• 清晰性： 虽然注解解决了技术问题，但应保持SQL代码的清晰和可读性。将注解放置在SQL语句的紧邻行，使其意图明确。
• 版本控制： 将带有这些注解的迁移文件纳入版本控制系统，确保团队成员都能遵循相同的最佳实践。
• 测试： 在开发和生产环境中进行goose up和goose down测试，验证迁移的正确性和鲁棒性。

6. 总结

unterminated dollar-quoted string错误在使用Goose创建包含复杂逻辑（尤其是内部带有分号）的PostgreSQL函数时是一个常见挑战。理解其根源在于Goose的默认SQL解析机制，并利用-- +goose StatementBegin和-- +goose StatementEnd这两个关键注解，可以有效地解决这一问题。通过正确地标记复杂SQL语句，我们能够确保Goose将它们作为单一的原子单元进行处理，从而实现平滑、可靠的数据库迁移。遵循这些实践，将有助于构建更健壮的数据库迁移流程。

以上就是解决Goose在PostgreSQL函数中报告“未终止的美元引用字符串”错误的详细内容，更多请关注其它相关文章！

# 但在  # 蚌埠建设银行网站  # 银川网站建设价格推荐  # 网站图片路径优化  # 临朐网站关键词优化  # 常熟外贸网站推广公司  # 自适应网站建设和运营  # 网站建设法语  # 抖音关键词排名广告位  # 曲周seo网站优化  # seo展现内容怎么排  # 相关文章  # go  # 都能  # 多个  # 尤其是  # 体内  # 这两个  # 这一  # 器中  # 是一个  # sql语句  # 工具  # go语言 

相关栏目： 【 Google疑问12 】 【 Facebook疑问10 】 【 优化推广96088 】 【 技术知识133117 】 【 IDC资讯59369 】 【 网络运营7196 】 【 IT资讯61894 】

相关推荐： 猫眼电影app怎么查询电影院的营业时间_猫眼电影影院营业时间查询教程  Windows Audio服务启动失败怎么办_电脑没声音的终极服务修复法【修复】  《原神》月之一版本新增书籍一览  视频号视频怎么提取文案?提取的文案如何优化与使用?  Excel如何快速找到并断开外部数据源链接_Excel外部数据源断开方法  《爱笔思画x》涂色教程  J*a中导出MySQL表为SQL脚本的两种方法  J*a中的值传递到底指什么_值传递模型在参数传递中的真正含义说明  Lar*el Eloquent：高效删除多对多关系中无关联子记录的父模型  哔哩哔哩黑名单怎么查看  《咸鱼之王》新版孙坚技能解析  京东快递包裹信息查询入口 京东快递官方查询平台入口  传统曲艺莲花落的表演形式是  企查查官网和爱企查 企查查企业查询官网入口  优化 WooCommerce 产品价格显示与自定义短代码集成  《新三国志曹操传》游历事件袁尚突围攻略  NumPy 高性能技巧：基于多列条件查找最近邻行索引的向量化实现  谷歌浏览器怎么把网页翻译成中文_Chrome网页翻译功能使用方法  如何查找哪个composer包引入了特定的依赖？  悟空浏览器如何恢复关闭的标签页 悟空浏览器撤销关闭网页快捷键设置  sublime如何处理超大文件不卡顿 _sublime打开大日志文件技巧  Lar*el如何创建自定义的辅助函数（Helpers）_Lar*el全局函数定义与加载方法  PDF文件去水印平台入口 PDF水印删除网址  狙击外星人小游戏在线链接_狙击外星人小游戏网页链接  优化 React onClick 事件处理：函数引用与箭头函数的对比  小米倒班助手添加日历提醒  Win11如何分屏操作_Win11多窗口分屏技巧  在Django中动态检查模型关联：一种灵活的解决方案  大熊猫抓取竹子的“大拇指”其实是什么？蚂蚁庄园课堂今天答案最新11月30日  解决jQuery多计算器输入字段冲突的教程  我的世界游戏平台入口 我的世界官方官网直达链接  百度地图离线地图无法加载如何解决 百度地图离线地图加载优化方法  我居然低估了 DeepSeek，这次更新它做到了这些！  支付宝如何解绑云闪付_支付宝与云闪付账户关联解除方法  小红书网页版怎么进 小红书网页版通用入口  优化Asyncio嵌套函数调度：使用生产者-消费者模式实现并发流处理  《豆瓣》私信用户方法  《360浏览器》自动保存账号密码设置方法  批改网网页版登录 批改网电脑版学生登录入口  Win11便笺在哪打开 Win11桌面便笺（Sticky Notes）使用方法【详解】  汽水音乐在线听歌网页版 汽水音乐在线听歌网页版入口  厨房地面防滑垫的油污怎么洗？ 机洗和手洗防滑垫的注意事项  晨报|开发商暗示《空洞骑士：丝之歌》DLC开发中 《合金装备4》有望重制  路由器DNS怎么设置最快 优化DNS提升上网速度教程  如何用mysql实现客户反馈管理_mysql客户反馈数据库方法  哔哩哔哩的|直播|间怎么送礼物_哔哩哔哩|直播|送礼操作指南  第五人格PC版怎么避免被封号_第五人格PC版防封号注意事项  t3出行如何使用微信支付  谷歌浏览器官网地址整理_谷歌浏览器新版直连2026稳定访问  PHP与SQL实践：高效实现数据复制与特定列值修改 

 2025-11-17