Sublime怎么格式化SQL_Sublime SQL代码美化教程【数据库】

3次阅读

sublime text 需借助插件实现 sql 格式化,推荐 codeformatter + sqlparse:pip install sqlparse 后配置 command 为 [“python”, “-m”, “sqlparse”, “-r”, “-o”, “stdout”],注意路径、版本兼容性及 mysql 扩展语法限制。

Sublime怎么格式化SQL_Sublime SQL代码美化教程【数据库】

sublime text 里没有内置 SQL 格式化功能

Sublime Text 本身不带 SQL 美化能力,Ctrl+Shift+P 搜 “Format” 也找不到原生命令。想格式化 SQL,必须装插件——这是最常被卡住的第一步。

常见错误现象:Package Control: Install Package 搜索 “SQL Formatter” 或 “SQL Beautify” 后装了多个同名但维护停滞的插件,结果快捷键无效、缩进错乱、中文注释被吞。

  • 推荐只装一个:插件名是 SQLTools(带 SQLTools Core 依赖)或轻量级的 SublimePrettyJson 的变种思路不适用,别试
  • 真正稳定可用的是 CodeFormatter 插件 + 配置外部 formatter,比如用 pg_formatpostgresql)或 sqlparse(Python 库)
  • windows 用户注意:如果路径含空格或中文,code_formatter 配置里的 cmd 参数会静默失败,建议把 sqlparse 装在 C:tools 这类干净路径下

用 sqlparse 做 Sublime 的 SQL 格式化后端

sqlparse 是 Python 写的纯解析器,不执行 SQL,安全、跨库、支持注释和方言关键词,比基于正则的插件靠谱得多。

使用场景:日常写 select / WITH / 多层嵌套子查询,需要保持缩进层级和换行逻辑清晰。

  • 先装 Python 包:pip install sqlparse(确认是全局 Python 环境,不是虚拟环境里装完 Sublime 找不到)
  • 再装 Sublime 插件 CodeFormatter,然后编辑其配置:Preferences → Package Settings → CodeFormatter → Settings – User
  • 填入关键配置项:"sql": {"command": ["python", "-m", "sqlparse", "-r", "-o", "stdout"]}
  • 注意参数含义:-r 表示“重排”,-o stdout 是必须的,否则插件收不到输出;漏掉会返回空结果

格式化后关键字大小写和缩进不一致?检查 sqlparse 版本

sqlparse 0.4.4 之后默认把关键字转大写,且缩进宽度固定为 2 空格。老项目若习惯小写或 4 空格,直接升级会破风格。

性能影响很小,单次格式化 100 行以内几乎无感;但打开大 SQL 文件(>500 行)时,反复触发格式化可能卡 ui,建议关掉「保存自动格式化」。

  • 查版本:python -c "import sqlparse; print(sqlparse.__version__)"
  • 降级方法:pip install sqlparse==0.4.3(这个版本还支持 --indent_width=4 参数)
  • 如果要用新版本但保留小写,得改 CodeFormatter 的调用命令,加 --keywords-case=lower,但注意该参数在 0.4.4+ 才生效
  • 别碰 --reindent--indent_width 混用,容易冲突导致缩进塌陷

MySQL 特有语法(如 `INTO OUTFILE`)格式化失败

sqlparse 默认按标准 SQL 解析,遇到 MySQL 扩展语法(ENGINE=InnoDBDELIMITER $$INTO OUTFILE)会报错或截断,错误信息通常是:ParseError: Expected end of statement, got 'INTO'

这不是插件问题,是解析器能力边界。此时不能硬扛,得切方案。

  • 临时解决:选中要格式化的部分(避开扩展语法块),再按快捷键 Ctrl+Alt+F
  • 长期办法:换用支持 MySQL 的 formatter,比如本地起个 docker run --rm -i jbergknoff/postgresql-format(需改写 CodeFormatter 的 cmd 调用)
  • 更务实的做法:这类 DDL/DML 混合脚本,直接丢到 MySQL 客户端里用 T 开启日志,人工调整缩进反而更快

真正在意格式一致性的人,最后都会发现:SQL 美化工具只是辅助,真正难的是统一团队的书写约定——比如是否允许隐式 JOIN、WHERE 条件顺序、括号换行位置。这些没法靠插件解决。

text=ZqhQzanResources