格式化

SQL 格式化

SQL 语句格式化、压缩和美化

输入 SQL
格式化结果
格式化结果将显示在这里

什么是 SQL 格式化?

SQL(Structured Query Language)是用于管理关系数据库的标准语言。SQL 格式化工具可以将压缩的 SQL 语句转换为易于阅读的格式,添加适当的缩进和换行,帮助开发者更好地理解和维护 SQL 代码。

功能特点

  • 格式化:自动识别 SQL 关键字并格式化,美化代码结构
  • 压缩:压缩 SQL 语句,移除多余空白和注释,减小文件大小
  • 自定义缩进:支持 2 空格、4 空格、Tab 缩进
  • 关键字大小写:可选择大写或小写关键字
  • 压缩率显示:实时显示压缩比例和大小变化
  • 快速复制:一键复制格式化或压缩结果

支持的 SQL 语法

  • SELECT 查询语句
  • JOIN(INNER、LEFT、RIGHT、FULL OUTER)
  • WHERE、GROUP BY、ORDER BY、HAVING
  • INSERT、UPDATE、DELETE 语句
  • CREATE、ALTER、DROP 等 DDL 语句

使用场景

  • 代码审查:格式化 SQL 便于代码审查
  • 文档编写:生成格式化的 SQL 文档
  • 日志分析:格式化日志中的 SQL 语句
  • SQL 优化:格式化后更容易分析查询结构

纯文本层面的 SQL 重排工具:把 55 个固定关键字统一成大写或小写,在关键字紧贴下一个字符处断行,缩进可选 2 空格、4 空格或「Tab」,另有折叠空白的压缩视图。适合整理从日志、工单、ORM 打印里粘出的一行长查询;它不解析语法,也不做校验。

两遍文本处理,没有语法分析

组件不构建语法树。第一遍拿一份固定的 55 个关键字清单(SELECT、FROM、WHERE、JOIN、各聚合函数,以及 GROUP BY、UNION ALL 这类多词短语)逐个做全文正则替换,用的是不区分大小写、带词边界的匹配,所以同一个词出现在引号字符串里也会被改大小写。第二遍逐字符扫描,跟踪单引号、双引号与反引号的开关状态,只在关键字紧接着的字符不是空格时插入换行;FROM、WHERE、JOIN、GROUP BY、ORDER BY、HAVING 六个词还会把缩进抬高一级。背后没有语法规则,因此它不会拒绝任何输入:把 SELECT 拼成 SELEC、括号不配对,照样被原样改写输出,错误提示行通常一直是空的。

断行为什么落在关键字之后

换行判断比较的是光标前的若干字符,因此换行被写在关键字后面而不是前面:COUNT(o.id) 会输出成 COUNT、一个换行、再接 (o.id)。这个判断左侧只检查前一个字符是否为空白,没有词边界,于是两字母的 OR 会命中 order_count 的开头,变成 or、换行、der_count;note 同样会被 NOT 切开。缩进计数器只加不减:六个别名子句各加一级,除了分号把它清零,没有任何一步会退回上一级,所以子查询、多表 JOIN 会一路右移,不会和父级对齐。反过来,关键字后面都带空格的输入几乎不会断行,输出只剩大小写变化。

压缩视图只压空白

压缩视图做的是两次替换加一次去首尾:先把所有连续空白折成一个空格,再删掉 (、)、,、; 两侧的空格。注释完全不在处理范围内,而结束 -- 行注释的那个换行也被折掉了,于是下一行原本的语句被并进注释,整条查询在数据库里就成了一句注释。, 的规则同样不看引号,('a, b', 'c, d') 会被压成 ('a,b','c,d'):语法仍然合法,字面量的值却已经变了。PostgreSQL 的 $$ 函数体没有特殊处理,里面的分号照旧被当成语句分隔,count(*) 与后续关键字之间那个空格也会消失。

实操示例

默认 2 空格下重排一行子查询

输入
select * from(select id from t where x = 1)
输出
SELECT * FROM
  (SELECT id FROM t WHERE x = 1)

FROM 后面紧跟 (,这是整段输入里唯一触发断行的位置;FROM 又正好是抬高缩进的六个关键字之一,所以第二行前面是 2 个空格。其余关键字后面都带空格,因此它们后面的内容没有再断行。切到 4 空格时第二行缩进四个空格;选「Tab」时存进组件的缩进值是 1,输出的其实是一个空格。

边界与常见误用

  • 缩进只有 2 空格、4 空格和「Tab」三档,而 Tab 存的值是 1,组件重复的是空格字符,因此每级缩进是一个空格,永远不会是真的制表符。
  • 不做任何校验:关键字拼错、括号不配对的语句照样被改写输出,输出区下方的错误提示一直是空的。
  • 不识别注释、美元引用和方括号标识符,PostgreSQL $$ ... $$ 函数体里的分号仍被当作语句结束并把缩进清零。
  • 只有格式化和压缩两步在本地完成;点「AI 优化」会把整段查询发到 /ai/generate 接口,再把返回结果写回输入框。
  • 输入框没有长度上限,每次按键都会重算整段文本,粘贴几 MB 的导库脚本时面板会明显卡顿。

相关工具

什么时候这个纯文本重排够用,什么时候该换成带语法树的格式化器

你要解决的问题本页(SQL 格式化)该换用什么
语句里有那张关键字表覆盖不到的语法:CTE、窗口函数、美元引用函数体整套处理都是对 55 个词的子串匹配。WITH、OVER、PARTITION、RETURNING 和 $$ 这类标记不在这张表里,它们连同你写下的大小写、旁边的缩进一起原样留着,只有夹在中间的表内词被翻成大写或小写。写普通 SELECT 还能看,碰 PL/pgSQL 函数体就是误导。按方言切词的格式化器:Node 上的 sql-formatter——npx sql-formatter query.sql 会把重排结果打到标准输出,方言在命令行参数里指定——或者 pgFormatter 提供的 pg_format。函数体、迁移脚本必须一字不动时选它们。
你想问的是「这段能不能跑」,而不是「排得好看不好看」输出面板对任何文本都会出结果,所以出来的东西干净与否说明不了语句对不对:这一环里唯一的解析器是你的眼睛,缺了 FROM 也得自己看出来。带解析器的检查——sqlfluff lint q.sql,或对一次性库执行 psql -f q.sql——语句坏掉会以非零状态退出。把它挂进 pre-commit,本页留着读。
想把一行长的查询拆成「一列一行」这是它真能做好的排版,而且靠的是标点不是语法:逗号后面没有空格时,逗号被推到下一行行首,于是 a.id,a.email,a.total 这样的选择列表会竖着排下来,逗号在前。团队规范要求逗号留在行尾、或与 SELECT 对齐,就只有带语法树的格式化器做得到。接受前置逗号就用本页,不接受就换。
大小写规范得能被同事原样复现大小写只有两档:表内的词全大写或全小写,表外的词不动,所以 desc、nulls、over 保持你写的样子。页面既不读也不写配置文件,别人没法在钩子里重放你这套设置。把配置提交进仓库的格式化器:prettier 配 prettier-plugin-sql,或 sql-formatter 自带的配置文件。编辑器、pre-commit、CI 跑的是同一份设置。只要有第二个人格式化同一批查询,就该换过去。
面对两百个迁移文件,而不是粘贴一段只有一个 textarea、一次一段,没有文件选择也没有 glob;每敲一个键都整段重扫。唯一的对外通道是工具栏上的 AI 按钮,不按它,SQL 就一直在本机。用 shell 循环:for f in migrations/*.sql; do npx sql-formatter "$f" > "$f.new"; done。同样是文本输出,不进浏览器,还能作为 diff 审阅。抽查一段用本页,整棵树用循环。

一个具体场景

把生成器吐出的一行查询竖成十一行,这个排版的代价是什么

代码生成器给的报表查询,逗号后面一个空格都没有:178 个字符、一行、9 个逗号、5 个选择列。其中 9 个逗号各自顶到新一行的行首,逗号在前、列名紧随其后、不带缩进,末尾的分号再单占一行。进出相差的 10 个字符就是插入的 10 个换行,输出 188 个字符、11 行。这条查询里每个子句关键字后面都跟着空格,SELECT、FROM、WHERE、GROUP BY 一处都没断;缩进选 1、2、4 个空格结果逐字节相同,因为没有任何子句关键字触发断行。如果前置逗号的列清单正是你要的,这份输出可以直接用;如果评审要求逗号留在行尾,就手动挪回去,或者把文件交给带解析器的格式化器。

常见问题

格式化会执行或修改我的 SQL 吗?
不会。工具只在本地解析文本并重排格式,不连接任何数据库、不执行语句。粘贴含表名、内网地址的生产 SQL 是安全的,但仍建议避免粘贴真实数据。
支持哪些 SQL 方言?
覆盖 MySQL、PostgreSQL、SQLite 等主流方言的通用语法(关键字大写、JOIN 缩进、子查询层级)。方言特有语法(如 PostgreSQL 的 :: 类型转换、窗口函数)按通用规则排版,不影响正确性。
关键字大写是必须的吗?
不是语法要求,是可读性约定:SQL 大小写不敏感,但关键字全大写后与小写的表名字段名视觉分离,长查询审阅效率明显更高。格式化工具的一键大写就是为这个约定服务的。

内容复核: