一、SQLFluff 是什么？

SQLFluff 是一個??開源的 SQL 代碼質量工具??，專注于通過自動化方式提升 SQL 代碼的可讀性、一致性和規范性。其核心功能包括：

1. ??代碼格式化??：自動調整縮進、空格、換行等格式問題，支持多種 SQL 方言（如 ANSI、PostgreSQL、Snowflake 等）。
2. ??語法檢查??：檢測代碼中的語法錯誤、命名規范問題（如表名/字段名是否符合規范）。
3. ??規則定制??：允許用戶通過配置文件自定義規則，適配團隊或項目的編碼標準。
4. ??與開發工具集成??：支持 VS Code 擴展、dbt/Jinja 模板引擎，可嵌入 CI/CD 流程實現自動化檢查。

適用場景

• ??團隊協作??：統一多人開發的 SQL 代碼風格，減少合并沖突。
• ??代碼審查??：在數據工程、數據分析流程中提前發現潛在問題。
• ??遺留代碼重構??：快速規范化歷史 SQL 腳本，提升可維護性。

---

二、基礎教程

1. 安裝與初始化

# 安裝 SQLFluff（Python 環境需 ≥3.6）
pip install sqlfluff# 初始化配置文件（生成 .sqlfluff）
sqlfluff init

2. 核心命令

命令	功能說明	示例
sqlfluff lint	檢查 SQL 文件的規范問題	sqlfluff lint query.sql
sqlfluff fix	自動修復可修正的格式問題	sqlfluff fix query.sql
sqlfluff parse	解析 SQL 并生成抽象語法樹（AST）	sqlfluff parse query.sql

3. 配置文件示例（.sqlfluff）

[sqlfluff]
dialect = postgres  # 指定 SQL 方言
exclude_rules = L003, L009  # 排除特定規則[sqlfluff:rules]
capitalisation_policy = lower  # 關鍵字小寫
indent_size = 4                # 縮進4空格
max_line_length = 120          # 最大行寬

4. 快速上手示例

??原始代碼（test.sql）??

SELECT a+b AS foo,c AS bar FROM my_table

??檢查問題??

sqlfluff lint test.sql --dialect postgres

輸出：

== [test.sql] FAIL
L:   1 | P:   8 | LT01 | Expected only single space before 'AS' keyword
L:   1 | P:  11 | LT02 | First line should not be indented

??自動修復??

sqlfluff fix test.sql --dialect postgres

修復后代碼：

SELECTa + b AS foo,c AS bar
FROM my_table

---

三、進階功能

1. ??多方言支持??
   通過 --dialect 參數切換數據庫類型（如 bigquery、snowflake），適配不同平臺的語法差異。

2. ??與 dbt 集成??
   在 dbt 項目中直接運行 SQLFluff，檢查模型文件中的 SQL 代碼：

   dbt lint --sqlfluff

3. ??自定義規則開發??
   可通過編寫 Python 插件擴展規則，例如禁止使用特定函數：

   # 自定義規則示例（需放置于 .sqlfluff/rules 目錄）
   from sqlfluff.core.rules import BaseRuleclass NoSelectStarRule(BaseRule):def _eval(self, segment, parent_stack):if segment.name == 'select_statement':if ' * ' in segment.raw:return LintResult(anchor=segment, description="禁止使用 SELECT *")

---

四、生產環境建議

• ??CI/CD 集成??：在 GitHub Actions 或 Jenkins 中添加 SQLFluff 檢查步驟，阻止不規范代碼合并。
• ??團隊規范文檔??：將 .sqlfluff 配置文件納入版本控制，確保全員遵循統一標準。
• ??定期重構??：結合 sqlfluff lint --recursive 批量檢查歷史代碼庫。

---

通過本教程，您可以快速掌握 SQLFluff 的核心功能。如需深入規則定制或高級用法，可參考 官方網頁。