Skip to main content
PawSQL Client for VS Code 将 PawSQL 的 SQL 审核、查询重写、索引推荐和性能验证能力带入 Visual Studio Code，适合在多语言代码仓库和 SQL 文件中快速分析当前语句。

​
目标

安装并配置 PawSQL Client for VS Code，在代码或 SQL 文件中快速优化选中的 SQL。

​
准备工作

需要一个兼容的 Visual Studio Code 安装，以及访问 VS Code 扩展市场（或 PawSQL 官方 / 企业可信仓库提供的离线扩展包）的权限。

​
安装扩展

从 Visual Studio Code 扩展市场安装，步骤详见安装 IDE 插件。安装后打开包含 SQL 的文件，确认目标语句附近出现 PawSQL 优化入口。 受限网络环境中，只使用 PawSQL 官方或企业可信软件仓库提供的离线扩展包。

​
连接 PawSQL 服务

1

打开 PawSQL 配置

从扩展设置或命令面板进入 PawSQL Client 配置。
2

配置服务地址

输入 PawSQL Cloud 或 PawSQL Server 的完整地址。
3

完成认证

按部署方式登录或配置所需凭据，不要把密码或令牌写入项目文件。
4

选择默认工作空间

选择与目标数据库类型、版本和 Schema 一致的工作空间。

​
优化 SQL

1

定位完整 SQL

在代码或 SQL 文件中定位目标语句，确认扩展能够正确识别语句边界。
2

使用默认工作空间

点击 SQL 提示中的 Optimize，使用当前默认工作空间运行优化。
3

指定其他工作空间

点击 Optimize…，从列表中选择本次任务使用的工作空间。
4

查看结果

打开 PawSQL 返回的审核问题、重写候选、索引建议和性能证据。
截图占位符 · /images/dev-tools/vscode-optimize.png

SQL 语句旁的 Optimize 优化入口

同一仓库包含多个数据库或环境时，不要长期依赖一个默认工作空间。使用 Optimize… 明确选择与当前 SQL 匹配的上下文。

​
阅读优化结果

结果的具体展示形式可能随扩展版本变化，建议按以下顺序检查：
  1. 原始 SQL 和识别出的数据库方言；
  2. 使用的工作空间和对象解析情况；
  3. 审核问题、严重级别和触发位置；
  4. 重写 SQL 及其优化依据；
  5. 推荐索引及与现有索引的关系；
  6. 启用验证时的执行计划或性能对比。

​
验证

运行一次优化，确认原始 SQL、识别出的数据库方言、工作空间、审核问题、重写候选、索引建议以及验证证据均正常返回。

​
应用重写或索引

插件输出是优化候选，不是直接发布指令。应用前应：
  • 验证查询结果和业务语义；
  • 检查参数类型、空值和边界数据；
  • 确认数据库版本支持相关语法；
  • 评估索引的写入和存储成本；
  • 在代表性环境验证执行计划和性能；
  • 通过代码评审和数据库变更审批。
如果性能验证需要连接数据库或实际执行 SQL，应先确认账号权限、目标环境和语句安全性。不要使用未经确认的数据修改语句进行首次连接测试。

​
常见问题

​
相关文档

工作空间与数据库上下文

输入待优化 SQL

查看优化结果

评估与落地建议