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

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

问题背景

Snowflake数据库支持对半结构化数据(如JSON)进行查询，可以使用冒号语法访问嵌套字段。例如details:type表示获取JSON对象details中的type字段值。然而，当字段名恰好是SQL保留关键字(如"type")时，SQL Formatter会错误地将其格式化到新行。

问题表现

原始SQL查询：

SELECT
  details:type
FROM
  transactions

被错误格式化为：

SELECT
  details:
type
FROM
  transactions

这种格式化不仅影响代码美观，更重要的是当启用关键字大写转换选项时，会导致查询失败，因为JSON键名是大小写敏感的。

技术分析

问题的根本原因在于SQL Formatter将冒号后的"type"识别为SQL关键字，并按照关键字格式化规则进行了处理。实际上，在Snowflake的JSON路径表达式中，冒号后的标识符应该被视为字段名而非SQL关键字。

解决方案

修复方案借鉴了类似问题的处理方式，将冒号(:)视为与点号(.)类似的路径分隔符。这样，冒号后的标识符就不会被当作独立的关键字处理，而是作为路径表达式的一部分保持原样。

影响范围

该修复主要影响以下场景：

1. 使用Snowflake数据库
2. 查询包含JSON/半结构化数据
3. JSON字段名恰好是SQL保留关键字

最佳实践

虽然此问题已在15.1.3版本中修复，但为了代码的清晰性和兼容性，建议在JSON路径表达式中对关键字字段名使用引号包裹，如details:"type"。这种做法不仅更明确，也能避免未来可能的解析问题。

总结

SQL格式化工具需要精确理解不同数据库特有的语法规则。Snowflake的半结构化数据查询语法就是一个典型案例，需要特殊处理以避免与标准SQL关键字的冲突。这次修复体现了SQL Formatter项目对多数据库方言支持的不断完善。