sublime如何为SQL文件提供格式化和语法提示? (SQLTools插件)

17次阅读

sublime Text 通过 sqlTools 插件可实现高质量 SQL 编辑:需安装插件、配置数据库连接以启用智能提示与执行,搭配外部 CLI 工具(如 sqlformat)完成格式化,即使离线也支持语法高亮、静态补全等基础功能。

sublime如何为SQL文件提供格式化和语法提示? (SQLTools插件)

sublime text 本身不原生支持 SQL 格式化和智能语法提示,但通过 SQLTools 插件(配合后端驱动)可以实现高质量的 SQL 编辑体验,包括语法高亮、自动补全、错误检查、格式化,甚至连接数据库执行查询。

安装 SQLTools 插件

打开 Sublime Text → Ctrl+Shift+Pwindows/linux)或 Cmd+Shift+PmacOS)→ 输入 Install Package → 回车 → 搜索并安装 SQLTools。注意:这是由 sqltools 官方维护的 Sublime 插件(gitHub 仓库名:SQLTools/SQLTools-sublime),不是同名的 VS Code 插件。

安装后需重启 Sublime 或手动启用插件(一般自动生效)。

配置数据库连接(启用语法提示与执行前提)

SQLTools 的智能提示、跳转定义、执行查询等功能依赖真实数据库连接。你需要:

  • 在项目根目录或用户配置目录下创建 SQLTools.sublime-settings 文件(可通过 Preferences → Package Settings → SQLTools → Settings 打开)
  • 添加一个或多个连接配置,例如 postgresql

{   "connections": {     "mydb": {       "driver": "postgres",       "host": "localhost",       "port": 5432,       "database": "myapp",       "user": "postgres",       "password": "123456"     }   } }

保存后,在 SQL 文件中右键 → SQLTools: Connect → 选择对应连接。成功连接后,字段名、表名、函数等才会出现准确补全和悬停提示。

SQL 格式化(需搭配外部 formatter)

SQLTools 本身不内置格式化引擎,但支持调用外部命令(如 pg_formatsqlformatsqlfluff)进行格式化:

  • 确保已安装对应 CLI 工具(例如:pip install sqlparsenpm install -g pg-format
  • SQLTools.sublime-settings 中配置 "formatter" 字段,例如:

"formatter": {   "command": "sqlformat",   "args": ["--reindent", "--keywords-upper", "--identifiers-lower"] }

配置完成后,在 SQL 文件中右键 → SQLTools: Format Query 即可一键美化当前选中或整个文件的 SQL。

基础编辑增强(无需连接也能用)

即使不连数据库,SQLTools 仍提供以下开箱即用能力:

  • .sql 文件自动启用高亮(基于内置 SQL 语法)
  • 关键字、数据类型、常用函数(如 count()COALESCE())静态补全
  • 括号自动匹配、引号/注释快捷键(Ctrl+Shift+Q 注释行)
  • 支持多光标编辑、列编辑(Ctrl+Alt+↑/↓)等 Sublime 原生特性

若想进一步提升体验,可额外安装 BracketHighlighter(括号高亮)或 AutoFileName(路径补全,对 IMPORTinclude 语句有帮助)。

基本上就这些。SQLTools 在 Sublime 中不是“点开即用”,但配置一次后,SQL 编写效率和准确性提升明显——尤其适合常写复杂查询、又习惯 Sublime 快捷键的用户。

text=ZqhQzanResources