SQL Formatter项目中的关键字大小写转换问题解析

在SQL代码格式化工具SQL Formatter中，用户报告了一个关于PostgreSQL方言下关键字大小写转换的问题。本文将深入分析该问题的技术背景、解决方案以及相关影响。

问题现象

当用户使用SQL Formatter对PostgreSQL语句进行格式化时，发现字段名"password"被错误地转换为大写形式"PASSWORD"。这种情况发生在配置文件中设置了"keywordCase": "upper"选项时。

示例输入SQL：

select
    id, username, password, email
from
    users
where
    username = 'foo' and password = 'bar';

实际输出结果：

SELECT
    id,
    username,
    PASSWORD,
    email
FROM
    users
WHERE
    username = 'foo'
    AND PASSWORD = 'bar';

技术原因分析

这个问题源于SQL Formatter的关键字识别机制。在PostgreSQL方言中，关键字列表包含了过多的非保留关键字，如"PASSWORD"。当格式化器遇到这些词时，会根据"keywordCase"配置将其转换为大写形式，即使它们实际上是作为标识符(字段名)使用的。

解决方案

项目维护者通过精简PostgreSQL的关键字列表解决了这个问题。在版本15.2.0中，移除了许多非保留关键字，使得像"password"这样的字段名不再被误认为关键字而进行大小写转换。

相关影响与权衡

这个修复带来了一些副作用，特别是在处理PostgreSQL特有的语法结构时。例如：

CREATE TABLE animals (
  id integer PRIMARY key generated always AS identity
);

在这个例子中，"KEY"、"GENERATED"、"ALWAYS"和"IDENTITY"等词没有被正确识别为关键字，导致它们保持了小写形式。这是由于在精简关键字列表时，一些本应被识别为关键字的词也被移除了。

技术权衡

SQL Formatter在处理关键字时面临两个选择：

1. 识别过多的词为关键字，可能导致普通标识符被错误转换
2. 识别过少的词为关键字，可能导致真正的关键字没有被转换

对于大多数用户来说，第一种情况更为严重，因此项目选择了第二种方案。特别是当同时使用"identifierCase": "lower"选项时，这个问题会更加明显。

未来改进方向

为了解决这个平衡问题，项目考虑引入"保留短语"的概念，即识别特定的关键字序列组合。例如：

• "PRIMARY KEY"
• "GENERATED ALWAYS AS IDENTITY"

这种方法可以在不扩大单个关键字识别范围的情况下，确保特定语法结构得到正确处理。

总结

SQL代码格式化中的关键字识别是一个复杂的问题，需要在准确性和全面性之间找到平衡。SQL Formatter项目通过不断优化关键字列表和引入新的识别机制，努力提供更智能的格式化体验。用户在使用时应当了解这些技术限制，并根据自己的需求选择合适的配置选项。