sublime text 本身不支持 sql 格式化,依赖插件实现;sqlbeautifier 和 sqltools 是目前兼容 sublime text 4 的仅两个持续维护方案,需注意安装拼写、python 环境、大小写保留及编码换行符配置。

Sublime Text 本身不支持 SQL 格式化,所谓“一键美化”全是插件干的活——装错、配错、路径错,格式化就静默失败,连报错都不给你看。
SQLBeautifier 安装后快捷键没反应?先确认包名拼写和 Sublime 版本兼容性
Package Control 搜索时必须输 SQLBeautifier(注意大小写、带 r、无空格),不是 SqlBeautify、sqlbeautifier 或 SQLFormatter。后者在 Sublime 4 下基本失效,选中代码按 Ctrl+Alt+F 后毫无反应,是因为插件根本没加载。
- 打开
Preferences → Package Settings → SQLBeautifier → Settings,如果菜单里压根没有这个选项,说明安装失败或名字输错了 - Sublime Text 4 用户请避开所有带 “Beautify” 结尾的旧插件,
SQLBeautifier和SQLTools是目前仅有的两个持续维护、兼容 ST4 的方案 - Windows 用户若用 Scoop 或 Chocolatey 安装的 Python,需确保
python --version在命令行能调用,否则插件内部调用会卡住
格式化后表名全变小写,MySQL 直接报错?改配置别硬扛
SQLBeautifier 默认把所有标识符(库名、表名、字段名)转成小写,遇到 MySQL 开启 lower_case_table_names=0 的环境,SELECT * FROM UserLog 会被改成 SELECT * FROM userlog,执行时报 Table 'db.userlog' doesn't exist。
- 进
Preferences → Package Settings → SQLBeautifier → Settings - 加入这一行:
"identifier_case": "preserve",保留原始大小写 - 别碰
"keyword_case"以外的其他 case 配置项——它只控制 SELECT/FROM 这类关键字,不影响标识符
需要支持 WITH、窗口函数、反引号字段名?优先选 SQLTools + sqlparse
SQLBeautifier 对 `user_id`、ROW_NUMBER() OVER (PARTITION BY ...)、嵌套 CTE 这类结构解析不稳定,容易换行错位或吞掉反引号。此时得切到 SQLTools,它能把格式化委托给外部工具,比如 sqlparse 或 pg_format。
- 先全局安装:
pip install sqlparse(确认是系统 Python,不是虚拟环境) - 安装
SQLTools后,在其设置里填:"formatter": "sqlparse",再加参数:"sqlparse_args": ["--reindent", "--keywords-upper", "--identifiers-lower"] - 注意:Windows 路径含空格(如
C:\Program Files\Python\)会导致调用失败,建议重装 Python 到C:\tools\python\
格式化多行 SQL 时中文注释消失?检查编码和换行符一致性
常见现象:SQL 里写 -- 查询用户登录日志,格式化后整行没了。这不是插件 bug,而是 sqlparse 默认只认 \n 换行,而 Windows 文件常用 \r\n;另外,Sublime 若以 UTF-8 with BOM 打开文件,sqlparse 会跳过开头 BOM 字节后的内容,导致注释被截断。
- 保存前手动转编码:菜单
File → Save with Encoding → UTF-8(去掉 BOM) - 统一换行符:
View → Line Endings → Unix (LF) - 如果仍丢注释,临时改
sqlparse_args加上--strip-comments=false
真正麻烦的从来不是怎么装插件,而是格式化后 SQL 能不能直接跑通——大小写、反引号、注释、换行符,任何一项错位都可能让 DBA 多花十分钟排查。别信“一键搞定”,每个项目得按实际数据库方言和团队规范调参。











