SQL代码美化神器：SqlBeautifier完整使用教程

SQL代码美化神器：SqlBeautifier完整使用教程

【免费下载链接】SqlBeautifier A sublime plugin to format SQL. It supports both sublime 2 and 3. 项目地址: https://gitcode.com/gh_mirrors/sq/SqlBeautifier

🎯 项目概述与核心价值

SqlBeautifier 是一款专为 Sublime Text 编辑器设计的 SQL 格式化插件，能够将杂乱的 SQL 代码自动转换为规范、易读的格式。该插件支持 Sublime Text 2 和 3 两个版本，基于强大的 python-sqlparse 库实现智能格式化功能。

🚀 快速安装指南

前置准备

在开始安装之前，请确保你已经安装了 Sublime Text 编辑器。如果没有安装，请先下载并安装适合你操作系统的版本。

安装步骤

1. 打开 Sublime Text 编辑器
2. 启动命令面板：
   • Windows/Linux：按下 Ctrl + Shift + P
   • Mac：按下 Cmd + Shift + P
3. 搜索并安装插件：
   • 在命令面板中输入 Package Control: Install Package
   • 在弹出的搜索框中输入 SqlBeautifier
   • 选择并确认安装

手动安装方法

如果通过 Package Control 安装失败，可以采用手动安装方式：

git clone https://gitcode.com/gh_mirrors/sq/SqlBeautifier

然后将整个项目文件夹复制到 Sublime Text 的 Packages 目录中。

⚙️ 核心配置详解

快捷键配置

插件提供了默认的快捷键设置，你可以根据需要进行调整：

Mac 系统：

{ "keys": ["super+k", "super+f"], "command": "sql_beautifier" }

Windows/Linux 系统：

{ "keys": ["ctrl+k", "ctrl+f"], "command": "sql_beautifier" }

格式化参数配置

通过编辑用户配置文件 SQL Beautifier.sublime-settings 来自定义格式化行为：

{
    "keyword_case": "upper",
    "identifier_case": null,
    "strip_comments": false,
    "indent_tabs": false,
    "indent_width": 2,
    "reindent": true
}

🔧 参数功能详解

keyword_case

控制 SQL 关键字的格式：

• "upper"：转换为大写（推荐）
• "lower"：转换为小写
• "capitalize"：首字母大写
• null：保持原样

identifier_case

控制标识符的格式：

• "upper"：转换为大写
• "lower"：转换为小写
• "capitalize"：首字母大写
• null：保持原样

strip_comments

• true：移除所有注释
• false：保留注释（默认）

indent_tabs

• true：使用制表符进行缩进
• false：使用空格进行缩进（默认）

indent_width

设置缩进宽度，默认值为 2

reindent

• true：重新调整缩进（默认）
• false：保持原有缩进

💡 实用操作技巧

单文件格式化

打开包含 SQL 代码的文件，按下快捷键即可对整个文件进行格式化。

选区格式化

如果只需要格式化部分代码，可以先选中需要格式化的区域，然后按下快捷键。

语法高亮

插件会自动将文件语法设置为 SQL，确保获得最佳的代码高亮效果。

🛠️ 故障排除与优化

常见问题解决

• 快捷键无效：检查快捷键配置是否正确
• 格式化失败：确保 SQL 语法正确，无语法错误
• 插件未加载：重启 Sublime Text 编辑器

性能优化建议

• 对于大型 SQL 文件，建议分段格式化
• 合理配置格式化参数，避免不必要的处理

📊 使用效果对比

格式化前：

select id,name,email from users where status='active' order by created_at desc

格式化后：

SELECT id,
       name,
       email
FROM users
WHERE status = 'active'
ORDER BY created_at DESC

通过 SqlBeautifier 插件，你可以显著提升 SQL 代码的可读性和维护性，让数据库开发工作更加高效专业。

【免费下载链接】SqlBeautifier A sublime plugin to format SQL. It supports both sublime 2 and 3. 项目地址: https://gitcode.com/gh_mirrors/sq/SqlBeautifier