SQL Formatter 项目中关于Snowflake半结构化数据查询的格式化问题解析

SQL Formatter 项目中关于Snowflake半结构化数据查询的格式化问题解析

sql-formatter 项目地址: https://gitcode.com/gh_mirrors/sqlf/sql-formatter

在SQL Formatter项目中，最近修复了一个关于Snowflake数据库半结构化数据查询格式化的bug。这个问题涉及到当JSON字段的键名恰好是SQL保留关键字时的处理方式。

问题背景

Snowflake数据库支持对半结构化数据（如JSON）进行查询，可以通过冒号语法访问嵌套字段。例如，details:type表示从details字段中获取type键的值。然而，当键名是SQL保留关键字（如"type"）时，SQL Formatter之前的版本会错误地将冒号后的内容换行显示。

问题表现

在15.1.2版本中，当格式化以下Snowflake SQL查询时：

SELECT
  details:type
FROM
  transactions

会错误地格式化为：

SELECT
  details:
type
FROM
  transactions

这种格式化不仅破坏了查询的可读性，更重要的是，当结合keywordCase: "upper"选项使用时，会将键名"type"转换为大写"TYPE"，导致查询失败，因为JSON键名是大小写敏感的。

技术分析

问题的根源在于SQL Formatter将冒号后的"type"识别为SQL保留关键字，并按照保留关键字的格式化规则进行处理。实际上，在半结构化数据查询中，冒号后的标识符应该被视为JSON键名而非SQL关键字。

解决方案

修复方案借鉴了类似问题的处理方式（如Transact-SQL中的点号分隔符问题）。在15.1.3版本中，SQL Formatter现在将冒号(:)视为与点号(.)类似的分隔符，不再将其后的标识符作为SQL关键字处理。

这意味着：

1. 冒号后的内容不再被错误换行
2. 即使使用keywordCase: "upper"选项，键名也不会被转换为大写
3. 查询保持了原有的语义和格式

最佳实践

虽然修复后可以直接使用details:type的写法，但从代码可维护性和兼容性角度考虑，建议使用引号包裹键名的方式details:"type"。这种写法：

• 明确表示这是一个字符串键名
• 避免未来可能的解析歧义
• 兼容更多SQL格式化工具

总结

这个修复展示了SQL Formatter项目对特定数据库语法特性的细致支持。对于使用Snowflake半结构化数据查询的开发者来说，15.1.3版本解决了关键字的错误格式化问题，使得代码格式化更加准确可靠。这也提醒我们，在处理不同SQL方言时，需要特别注意其特有的语法结构和保留关键字。

sql-formatter 项目地址: https://gitcode.com/gh_mirrors/sqlf/sql-formatter