0

0

sublime如何安装并配置SQL格式化_sublime美化SQL代码方法【详解】

裘德小鎮的故事

裘德小鎮的故事

发布时间:2026-01-24 15:27:11

|

411人浏览过

|

来源于php中文网

原创

Sublime Text需通过SQLTools插件配合外部格式化器(如pg_format)实现稳定SQL格式化;安装后配置formatter及formatter_path,用Cmd+Alt+F(macOS)或Ctrl+Alt+F(Win/Linux)触发,支持方言注释切换。

sublime如何安装并配置sql格式化_sublime美化sql代码方法【详解】

Sublime Text 本身不带 SQL 格式化功能,必须通过插件实现;最稳定、兼容性最好的方案是安装 SQLTools 配合外部格式化器(如 pg_formatsqlparse),而非依赖纯 Python 实现的轻量插件——后者在复杂 CTE、嵌套子查询或方言(如 HiveQL、T-SQL)上极易崩或错排。

安装 SQLTools 插件并启用格式化支持

SQLTools 是 Sublime 上唯一支持多数据库方言 + 可绑定外部 formatter 的成熟插件。它不自带格式化逻辑,但提供了清晰的配置入口和命令触发机制。

  • Ctrl+Shift+P(Windows/Linux)或 Cmd+Shift+PmacOS)打开命令面板,输入 Package Control: Install Package 回车,再搜索并安装 SQLTools
  • 安装后重启 Sublime,确保状态栏右下角出现数据库连接图标(否则说明插件未激活)
  • 该插件默认不开启格式化,需手动配置:打开 Preferences → Package Settings → SQLTools → Settings,在用户设置中添加 "format_on_save": false"formatter": "pg_format"(或其他已安装的 formatter 名)

配置外部 SQL 格式化器(以 pg_format 为例)

pg_format 是 Perl 编写的 PostgreSQL 官方推荐格式化器,对标准 SQL 兼容性极好,且能处理窗口函数、WITH RECURSIVE 等现代语法。Sublime 通过 shell 调用它,因此必须确保其可执行文件在系统 PATH 中。

  • macOS:运行 brew install pgformatter,安装后执行 which pg_format 应返回类似 /opt/homebrew/bin/pg_format
  • Ubuntu/Debian:执行 sudo apt install pgformatter,验证路径为 /usr/bin/pg_format
  • Windows:下载 pgFormatter Windows 二进制包,解压后将含 pg_format.exe 的目录加入系统环境变量 PATH
  • SQLTools 设置中指定完整路径(尤其 Windows 用户):"formatter_path": "C:\\tools\\pgFormatter\\pg_format.exe",避免因 PATH 解析失败导致格式化命令静默失败

快速格式化当前 SQL 文件的正确操作流程

别用右键菜单里模糊的 “Format SQL” 选项——那是旧版插件残留项,大概率报错 command not found: sql_beautify。必须走 SQLTools 绑定的标准化路径。

SpeechEasy
SpeechEasy

SpeechEasy是一种合成语音解决方案,可以让用户从文本生成高质量、易于理解的音频。

下载
  • 确保当前文件语法高亮为 SQL(右下角显示 “SQL”,不是 “Plain Text”;若不是,点击右下角语言名 → 输入 SQL → 选中 SQL
  • 快捷键 Ctrl+Alt+F(Windows/Linux)或 Cmd+Alt+F(macOS)直接调用格式化命令(前提是 SQLTools 设置中 "formatter" 已正确配置)
  • 若报错 Formatter 'pg_format' not found,检查 formatter_path 是否指向真实可执行文件,且该文件有执行权限(Linux/macOS 运行 chmod +x /path/to/pg_format
  • 格式化结果会原地替换全文,不创建新标签页——这是预期行为,无需担心覆盖
-- 示例:原始混乱 SQL(缩进错乱、关键字大小写混用)
SELECT a.id,b.name FROM users a JOIN orders b ON a.id=b.user_id WHERE b.status='paid' ORDER BY b.created_at DESC LIMIT 10;

执行 Cmd+Alt+F 后自动变为:

SELECT
  a.id,
  b.name
FROM users a
JOIN orders b ON a.id = b.user_id
WHERE b.status = 'paid'
ORDER BY b.created_at DESC
LIMIT 10;

注意:pg_format 默认按 PostgreSQL 方言解析,若写的是 MySQL 或 SQLite 语句,需在文件首行加注释 -- pg_format: mysql-- pg_format: sqlite 切换方言,否则 GROUP_CONCATIFNULL 等函数可能被误判为语法错误。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

773

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

684

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

765

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

699

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1405

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

570

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

579

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

751

2023.08.11

c++ 根号
c++ 根号

本专题整合了c++根号相关教程,阅读专题下面的文章了解更多详细内容。

22

2026.01.23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
MySQL 教程
MySQL 教程

共48课时 | 1.9万人学习

MySQL 初学入门(mosh老师)
MySQL 初学入门(mosh老师)

共3课时 | 0.3万人学习

简单聊聊mysql8与网络通信
简单聊聊mysql8与网络通信

共1课时 | 808人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号