开发手册
SQL 格式化美化
从日志里抠出来的一条 SQL,挤成一行、大小写混乱、缩进全无。贴进来按方言排整齐,也能反过来压成一行。
① 粘贴 SQL
② 复制结果
使用说明
为什么值得排一下
日志里、慢查询里、别人贴给你的 SQL,通常是一条几百字符的长行。字段一多,就分不清 WHERE 里的条件属于哪个 JOIN,也看不出哪个子查询返回了整张表。格式化之后,子句各归各位,问题往往自己就露出来了。
三种排版风格
- 标准换行:每个子句单独起行,字段竖向排列。最清晰,也最占屏幕。
- 表格左对齐:关键字靠左补齐,后面的内容对齐成一列,适合纵向浏览整段脚本。
- 表格右对齐:关键字靠右对齐,子句层级用缩进体现,眼睛沿着右边缘扫就能找到子句。
压缩模式
压缩不是简单地把换行换成空格。它先做词法扫描,把单引号字符串、双引号标识符、反引号、美元引用($$...$$)、行注释与块注释整段识别出来,再合并语法上可省略的空白。所以 'a, b' 里的逗号和空格不会被误删,-- 注释 也不会把后面的语句吞掉。
方言的差别
MySQL 用反引号包表名,PostgreSQL 用双引号;SQL Server 用 TOP 10,其余多用 LIMIT 10;Oracle 的 CONNECT BY、BigQuery 的 UNNEST 都是各自独有的关键字。选方言的作用是让格式化器按对应语法切分子句,选错了容易切出奇怪的对齐,但不会改动语句内容。
不支持的情况
存储过程、触发器等带 BEGIN ... END 与 DELIMITER 的整段脚本,多数格式化器都会解析失败,属于正常现象,把内部单条语句拿出来分别格式化即可。
常见问题
为什么要选方言?
不同数据库的标识符引用符、关键字集合与内置函数都不一样。比如 MySQL 用反引号包裹表名,PostgreSQL 用双引号,SQL Server 有 TOP 而 MySQL 用 LIMIT。选对方言,格式化时不认识的关键字不会被拆错行,函数名也不会被误当成列名。
压缩成一行会不会破坏数据?
不会。压缩用的是词法扫描而不是正则替换:单引号字符串、双引号标识符、反引号、美元引用($$...$$)、行注释与块注释都会被整体识别,字符串里的空格、逗号和换行原样保留,只合并语法层面可以省略的空白。
格式化会改变 SQL 的执行结果吗?
不会。格式化只调整空白与关键字大小写,不增删词法单元,解析树不变。唯一需要留意的是 PostgreSQL 里未加引号的标识符会被折成小写,如果你把关键字统一成小写,只要标识符本身没加引号,语义也不受影响。
报语法错误怎么办?
工具会指出卡住的行列位置。常见原因是括号没闭合、语句被截断、方言选错(例如把含 TOP 的语句按 MySQL 解析),或者用了该工具不支持的存储过程语法。可以先把语句拆成几条分别格式化,定位到具体那一段。
SQL 会上传到服务器吗?
不会。格式化在浏览器里完成,SQL 内容不会离开本机。只有首次打开时需要联网加载格式化引擎,之后断网也能继续用。