本页是在 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