SQL Beautify 技术文档

SQL Beautify 技术文档

sql-beautify VS Code extension that beautifies SQL(HQL). 项目地址: https://gitcode.com/gh_mirrors/sq/sql-beautify

1. 安装指南

1.1 安装方式

SQL Beautify 是一个 Visual Studio Code (VS Code) 扩展，可以通过 VS Code 插件市场进行安装。以下是安装步骤：

1. 打开 VS Code。
2. 点击左侧活动栏中的扩展图标（或按 Ctrl+Shift+X）。
3. 在搜索框中输入 SQL Beautify。
4. 找到 SQL Beautify 扩展，点击 Install 按钮进行安装。

1.2 安装确认

安装完成后，您可以在 VS Code 的扩展列表中看到 SQL Beautify 已安装并启用。

2. 项目的使用说明

2.1 基本功能

SQL Beautify 提供了以下主要功能：

2.1.1 Beautify SQL

• 功能描述: 一键美化 SQL 代码。
• 使用方法:
  1. 确保当前文件的语言设置为 SQL。
  2. 选择需要美化的 SQL 代码块。
  3. 按下 Alt+Shift+f 快捷键。

2.1.2 Beautify SQL DDL (仅限 Hive SQL)

• 功能描述: 一键美化 SQL DDL 代码。
• 使用方法:
  1. 确保当前文件的语言设置为 SQL。
  2. 选择需要美化的 DDL 代码块。
  3. 按下 Alt+Shift+l 快捷键。

2.1.3 Extract SQL DDL (仅限 Hive SQL)

• 功能描述: 从 Insert 语句中提取 DDL。
• 使用方法:
  1. 确保当前文件的语言设置为 SQL。
  2. 选择需要提取 DDL 的 Insert 语句代码块。
  3. 按下 Alt+Shift+; 快捷键。

2.2 自定义样式

SQL Beautify 允许用户自定义格式化样式。您可以在 VS Code 的设置中找到相关选项进行配置。详细的自定义说明可以参考 功能说明。

3. 项目API使用文档

SQL Beautify 主要通过 VS Code 的快捷键和设置进行操作，没有提供额外的 API 接口。所有功能均通过 VS Code 的扩展机制实现。

4. 项目安装方式

SQL Beautify 的安装方式已在 1. 安装指南 中详细说明。请按照步骤进行安装。

---

通过以上文档，您应该能够顺利安装并使用 SQL Beautify 扩展来美化您的 SQL 代码。如果在使用过程中遇到任何问题，欢迎通过 GitHub Issues 或微信联系开发者。

sql-beautify VS Code extension that beautifies SQL(HQL). 项目地址: https://gitcode.com/gh_mirrors/sq/sql-beautify