SQLFluff PostgreSQL 方言中存储过程WITH子句支持问题分析

SQLFluff 是一款流行的 SQL 代码格式化工具，它通过支持多种数据库方言来确保不同数据库系统的 SQL 代码风格一致性。在最新版本中，用户发现 PostgreSQL 方言对存储过程中的 WITH 子句（公共表表达式 CTE）支持存在缺陷。

问题背景

PostgreSQL 支持在存储过程中使用 BEGIN ATOMIC 块来定义过程体，这种语法允许在过程体内执行多个 SQL 语句。然而，当存储过程体内包含 WITH 子句时，SQLFluff 的 PostgreSQL 方言解析器会报错，无法正确识别这种语法结构。

问题表现

当用户尝试格式化以下 PostgreSQL 存储过程时：

CREATE PROCEDURE abc.cdf()
LANGUAGE sql
BEGIN ATOMIC
WITH tbl2 AS (
SELECT a.apple
FROM tbl1 a
)

SELECT t.apple
FROM tbl2 t
;
END;

SQLFluff 会抛出解析错误："Found unparsable section: 'BEGIN | ATOMIC\nWITH tbl1 AS (\nSELECT'"。这表明解析器无法正确处理存储过程体内的 WITH 子句结构。

技术分析

问题的根源在于 PostgreSQL 方言定义中，存储过程体（function_definition）的语法规则没有包含 WithCompoundStatementSegment 选项。当前实现只支持简单的 SELECT 语句，而没有考虑可能存在的 CTE 表达式。

解决方案有两种：

1. 显式添加 WithCompoundStatementSegment 作为可选语法元素
2. 使用 OneOf 结构同时支持 WithCompoundStatementSegment 和 SelectStatementSegment

解决方案

推荐采用第二种方案，修改 PostgreSQL 方言定义，在存储过程体的语法规则中添加对 WITH 子句的支持：

OneOf(Ref("WithCompoundStatementSegment"), Ref("SelectStatementSegment")),

这种修改更加全面，不仅解决了当前问题，还能更好地支持未来可能添加的其他语句类型。

影响范围

此问题影响所有使用 SQLFluff 格式化 PostgreSQL 存储过程的用户，特别是那些在存储过程中使用 CTE 表达式的场景。修复后将提升工具对 PostgreSQL 高级特性的支持度。

最佳实践

对于需要在存储过程中使用复杂查询的用户，建议：

1. 确保使用最新版本的 SQLFluff
2. 在复杂查询中使用明确的 CTE 表达式提高可读性
3. 考虑将特别复杂的逻辑拆分为多个存储过程

此修复将显著提升 SQLFluff 对 PostgreSQL 存储过程格式化的准确性，使开发人员能够更自信地使用 CTE 等高级查询特性。