SQL Beautify：VSCode SQL代码美化插件使用指南

SQL Beautify：VSCode SQL代码美化插件使用指南

【免费下载链接】sql-beautify VS Code extension that beautifies SQL(HQL). 项目地址: https://gitcode.com/gh_mirrors/sq/sql-beautify

项目介绍

SQL Beautify是一款专为Visual Studio Code设计的开源扩展程序，能够帮助开发者轻松美化SQL和HQL代码。该插件基于JavaScript开发，特别增强了对Hive SQL的支持，适合数据库管理和开发人员使用。

主要功能特性

1. 一键美化SQL代码

确保当前文档语言模式设置为SQL，选中需要美化的SQL代码块，使用快捷键Alt+Shift+f即可快速格式化代码。

2. 美化SQL DDL语句（专为Hive SQL设计）

使用快捷键Alt+Shift+l可以专门美化DDL语句，这对于数据库结构定义语言特别有效。

3. 从Insert语句提取DDL

通过快捷键Alt+Shift+;可以从Insert语句中提取DDL结构，极大提高开发效率。

4. 自定义美化风格

插件提供了丰富的自定义选项，可以在VSCode设置中进行配置：

• 关键词大写转换：将SQL关键词自动转换为大写
• 逗号位置设置：控制逗号放在字段前面还是后面
• 缩进字符设置：使用空格或制表符进行缩进
• AS对齐长度：自定义字段长度阈值，控制AS关键词的对齐行为

安装方法

通过VSCode扩展市场安装

1. 打开VSCode，点击左侧扩展视图图标（或按Ctrl+Shift+X）
2. 在搜索框中输入"SQL Beautify"
3. 找到由clarkyu开发的扩展，点击安装按钮

手动安装

如需从源码安装，可以使用以下命令：

git clone https://gitcode.com/gh_mirrors/sq/sql-beautify
cd sql-beautify
npm install

配置说明

在VSCode设置中搜索"sql-beautify"可以找到以下配置项：

• extension.uppercase: 关键词转换为大写（默认true）
• extension.comma_location: 逗号位置设置（默认false）
• extension.bracket_char: 缩进字符设置（默认false）
• extension.as_loc_cnt: AS对齐长度阈值（默认150字符）

使用注意事项

1. 兼容性说明：插件在Hive SQL上兼容性最佳，其他SQL方言使用时需谨慎
2. 分段格式化：建议对代码分段进行格式化，避免一次性格式化整个文件
3. 错误恢复：如遇问题可使用Ctrl+Z恢复代码
4. 语言模式：确保文档语言模式设置为SQL或HQL

版本更新

最新版本0.3.22修复了多个Bug，包括关键词小写转换问题和lambda表达式格式化问题。详细更新日志可查看项目中的CHANGELOG.md文件。

技术支持

如遇到使用问题，可以通过以下方式获取帮助：

• 查看项目文档和配置说明
• 检查常见问题解答

SQL Beautify插件将持续更新，为开发者提供更好的SQL代码格式化体验。

【免费下载链接】sql-beautify VS Code extension that beautifies SQL(HQL). 项目地址: https://gitcode.com/gh_mirrors/sq/sql-beautify