首页
/ pgFormatter项目中的SET FROM CURRENT语法格式化问题解析

pgFormatter项目中的SET FROM CURRENT语法格式化问题解析

2025-07-08 20:00:36作者:凤尚柏Louis

在PostgreSQL数据库开发中,函数定义是一个常见的操作。pgFormatter作为一款流行的SQL代码格式化工具,能够帮助开发者保持代码风格的一致性。然而,在处理某些特殊语法时,格式化工具可能会出现不符合预期的行为。

问题背景

PostgreSQL函数定义支持使用SET variable FROM CURRENT语法,这一特性允许函数在创建时捕获当前会话的参数值。这是一个非常有用的功能,特别是在需要保持函数执行环境一致性的场景中。

格式化问题表现

当使用pgFormatter对包含SET variable FROM CURRENT语法的函数定义进行格式化时,工具会将FROM关键字错误地识别为SQL查询中的FROM子句,从而导致格式化后的代码出现不合理的换行。例如:

CREATE FUNCTION name ()
  RETURNS text
  LANGUAGE plpgsql
  SET search_path
FROM
  current
  AS $$
BEGIN
  RETURN 'text';
END;
$$;

而实际上,正确的格式化结果应该是:

CREATE FUNCTION name ()
  RETURNS text
  LANGUAGE plpgsql
  SET search_path FROM current
  AS $$
BEGIN
  RETURN 'text';
END;
$$;

技术原理分析

这个问题源于pgFormatter的词法分析逻辑。在Beautify.pm模块中,第2097行代码将FROM关键字统一处理为查询语句的分隔符:

elsif ( $token =~ /^(?:FROM|WHERE|SET|RETURNING|HAVING|VALUES)$/i )

这种处理方式没有考虑到SET...FROM CURRENT这一特殊语法结构,导致格式化时产生了错误的换行。

解决方案

项目维护者已经通过提交6ef53a3修复了这个问题。修复后的版本能够正确识别SET...FROM CURRENT语法结构,不再将其中的FROM关键字误认为查询分隔符。

最佳实践建议

对于使用pgFormatter的开发者,建议:

  1. 确保使用最新版本的pgFormatter,以获得最准确的格式化结果
  2. 对于复杂的函数定义,格式化后应进行人工检查
  3. 了解PostgreSQL特有的语法结构,这有助于识别格式化工具可能存在的问题

总结

SQL格式化工具在提高代码可读性方面发挥着重要作用,但它们也可能无法完美处理所有特殊语法。了解工具的限制和特性,结合人工审查,才能确保最终代码的质量和可维护性。pgFormatter项目团队对这类问题的快速响应也体现了开源社区对代码质量的持续追求。

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8