本页是在 Dev Tools Suite 中格式化与壓縮 SQL 的权威指南。阅讀時可使用上方交互式 SQL Formatter，或跳转到下方章节。所有解析与格式化在瀏覽器内通过 sql-formatter 完成 — 查询、模式名和示例数據从不上传服務器。

SQL Formatter 為人类美化多行 SQL，為传输壓縮 SQL。自动将關鍵字大寫（SELECT, FROM, WHERE），应用按子句縮进，并遵循 sql-formatter 庫的方言語法 — 与许多 IDE 扩展和 CLI 格式化器使用相同引擎。

你将获得

• 对称雙栏：左侧 SQL 輸入，右侧格式化或壓縮輸出
• 13 个方言解析器，分组為核心關系型、云仓庫、大数據、企業级
• Beautify 与 Minify 模式，实時自动格式化（防抖）及顯式 Process 按鈕
• 面板页眉的方言選擇器与 Strip comments — 无额外占高選项行
• 大型 SELECT 树的可折叠格式化輸出（Beautify）
• 方言解析器无法讀取輸入時的行列解析錯誤提示
• 可選 URL 共享：?mode=minify&dialect=postgresql 保留模式与方言

在以下情况使用

• 从日志、BI 或 ORM 粘贴临時 SQL，审查前需要可讀縮进
• 在应用代碼中嵌入 SQL，需要單行壓縮字串
• 使用 PostgreSQL、Snowflake、BigQuery、Spark 或 Oracle，需要解析器识别方言關鍵字
• 提交或發布前剥离块注释与行注释

不要期望

• 語义驗證 — 格式化成功不代表在服務器上可执行
• 自动查询计划、性能 lint 或模式感知重寫
• 完美保留所選方言未覆盖的每个厂商扩展
• 服務端 EXPLAIN 或执行 — 仅為布局与空白工具

控件位于 SQL QUERY 面板页眉，使輸入輸出編輯器等高。工具栏下无單独選项行。

鍵盤快捷鍵

• Ctrl/Cmd+Enter — Process
• Ctrl/Cmd+L — 清空工作区

始终選擇与查询运行环境匹配的方言。解析器按方言使用不同關鍵字列表、函数名和注释规则。通用 ANSI 片段可安全默认 Standard SQL。

不支援 Cassandra CQL — 不在 sql-formatter 方言集中。Cassandra 工作负载请用 CQL 专用格式化器。

Beautify 与 Minify 共享方言選擇器与 Strip comments，但輸出形态不同。

示例

輸入：select id, name from users where active = 1 — Beautify 產生带 SELECT/FROM/WHERE 大寫的縮进行。Strip 關閉的 Minify 產生單行：select id, name from users where active = 1。

1. 从侧栏 Formatters 開啟 SQL Formatter。
2. 在左侧編輯器粘贴 SQL、从工作階段工具栏上传 .sql，或拖放到空状态。
3. 選擇与数據庫匹配的方言（如 Snowflake 工作表用 snowflake）。
4. 若輸入含不需要的 -- 或 /* */ 注释，可選 Strip comments。
5. 可讀 SQL 選 Beautify，紧凑單行選 Minify。
6. 查看右侧輸出。修複解析錯誤横幅 — 编辑后点擊關閉。
7. 複製、下载或将輸出换回輸入再处理。
8. 共享 ?dialect=bigquery&mode=minify 鏈接以開啟相同設定。

Flyway、Liquibase 和 ORM 迁移文件在 SELECT 列表、JOIN 和 WHERE 分到一致行時更易审查。

工作流程

1. 将方言設為 postgresql、transactsql、mysql 或 sqlite 以匹配迁移目標。
2. 粘贴產生 diff 或 ORM 輸出的原始迁移 SQL。
3. 若行内注释说明意图，Strip 關閉下 Beautify。
4. 開 PR 前将格式化 SQL 複製回迁移文件。

提示

格式化不针对 live 模式驗證。外观更改后请在 staging 数據庫运行迁移。

分析工程师常从 Snowflake、BigQuery 或 Redshift 控製台複製大小寫不一、行被壓扁的 SQL。

Snowflake / BigQuery / Redshift

• Beautify 前選 snowflake、bigquery 或 redshift 以正确解析仓庫函数。
• 从含 -- 工作階段笔记的笔记本導出時使用 Strip comments。
• 极宽 SELECT 列表在 Beautify 后用 Expand all / Collapse all。

Spark / Trino / Hive

• Databricks 笔记本与 Spark SQL 管道用 spark。
• 跨目录 Presto 兼容联邦查询用 trino。
• 遗留 HiveQL 用 hive — 解析覆盖遵循 sql-formatter Hive 规则。

应用代碼常将 SQL 存為模板字串。Minify 减少 JavaScript、Python 或 Go 中單行的字节与转义。

1. 将可讀 SQL 粘贴到輸入面板。
2. 若查询含调试笔记，启用 Strip comments。
3. 切换到 Minify 模式。
4. 将單行輸出複製到字串字面量（注意語言引號转义）。

若源碼要可讀而运行時要紧凑，文件保留 beautify 版，仅对构建產物 minify。

审查前规范化 SQL，使 diff 聚焦逻辑而非空白噪声。

• 同事在工單贴單行 SQL 時，比较两侧都 beautify。
• 用大寫關鍵字作一致風格 — Beautify 自动应用。
• 格式化两版后若需語义 diff，管道到 Text Diff。

Strip comments 适用于 Beautify 与 Minify。启用時按已实现方言规则在格式化前移除注释。

Strip 關閉時（Minify）

Minify 仍将空白壓成一行但保留注释文字。注释须随查询發布時使用。

解析失败時红色横幅顯示带行列的 Parse error。可用時輸入編輯器高亮錯誤行。

常见修複

1. 方言錯誤 — 切换到实际引擎（如 Oracle 包用 plsql，非 Standard SQL）。
2. 未闭合字串或括號 — 在报告行附近平衡引號与括號。
3. 尾逗號或未完成子句 — 先完成 SELECT 列表与 CTE。
4. 粘贴了非 SQL — 去掉查询外的 shell 或 JSON 包装。
5. 通用模式下的方言語法 — 试厂商方言或简化不支援的扩展。

有效查询仍失败時，sql-formatter 可能未覆盖该語法变體。向上游报告或手动格式化简化子集。

SQL Formatter 100% 在瀏覽器运行。sql-formatter 庫动态加载；在主线程 JavaScript 中格式化。

• 查询文字不發送到 Dev Tools Suite 服務器
• 輸入、輸出、方言与 Strip comments 偏好可保存在裝置 localStorage
• URL 参数（?dialect=、?mode=）仅反映設定 — 不含 SQL 正文
• 处理生產数據或 PII 后清空工作区（Ctrl/Cmd+L）

• Beautify 前匹配执行环境方言 — 格式化成功 ≠ 运行成功
• 人类用 Beautify，机器用 Minify
• 注释記錄業務规则時 Strip 關閉；導出与嵌入時開启
• 含美元引號或特殊字面量的 minify 輸出在 staging 驗證
• 大脚本用工作階段历史与文件上传，勿粘贴到會改引號的聊天应用
• 比较同一报表查询两版格式化結果時结合 Text Diff