Skip to content

Commit eff6250

Browse files
committed
update docs
1 parent 2f57485 commit eff6250

4 files changed

Lines changed: 9 additions & 10 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
## Introduction
55
PawSQL Client enables developers to access core capabilities of the PawSQL directly within VSCode enviroment. PawSQL provides sophisticated SQL optimization features including smart index recommendations and query rewrites. More about PawSQL's capabilities, please visit [https://docs.pawsql.com](https://docs.pawsql.com).
66

7-
[Watch PawSQL Client Demo](https://www.bilibili.com/video/BV19aDBYAEcr/)
7+
[PawSQL Client Demo](/resources/demo.gif)
88

99
## Features
1010
- **Optimize by Clicks**: Get optimization recommendation for your SQL query by one click.

README_zh-CN.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
PawSQL Client让开发者能够在VS Code开发环境中直接使用PawSQL引擎强大的SQL优化能力,包括智能索引推荐、查询重写建议、自动化性能验证等。PawSQL Client需要结合PawSQL优化平台([PawSQL Cloud](https://pawsql.com)或企业私域部署的PawSQL优化平台)一起使用。关于更全面的PawSQL的SQL优化能力,请参考[PawSQL官方文档](https://docs.pawsql.com)
88

9-
[PawSQL Client](https://www.bilibili.com/video/BV19aDBYAEcr/)
9+
[PawSQL Client Demo](/resources/demo.gif)
1010

1111
## 功能
1212

@@ -28,13 +28,11 @@ PawSQL Client让开发者能够在VS Code开发环境中直接使用PawSQL引擎
2828

2929
1. 点击 VSCode 左侧边栏的 PawSQL 图标,进行PawSQL配置
3030
2. 在配置页面中正确填写以下配置项:
31-
- Backend URL (例如:`https://pawsql.com`)
32-
- Frontend URL (例如:`https://pawsql.com`)
33-
- API Key (您的 PawSQL API 密钥,可以在优化平台的用户设置页面查看)
31+
- PawSQL Server (例如:`https://pawsql.com`)
32+
- Account (您在PawSQL Server的账号)
33+
- Password (PawSQL Server账号的密码)
3434
3. 点击"保存"按钮
3535

36-
配置成功后,左侧边栏将加载当前用户的工作空间列表(最近 100 个)。
37-
3836
## 使用说明
3937

4038
### 在VS Code环境中进行SQL 优化
@@ -51,13 +49,12 @@ PawSQL Client让开发者能够在VS Code开发环境中直接使用PawSQL引擎
5149

5250
优化完成后:
5351

54-
- 优化结果将在 VSCode 内的 WebView 中显示
55-
- 点击"在浏览器中查看优化详情"可查看更多信息,包括:
52+
- 您可以在VSCode中打开的tab页中查看优化结果
53+
- 还可以点击"在浏览器中查看优化详情"可查看更多信息,包括:
5654
- SQL 对比
5755
- 执行计划对比
5856
- 其他详细分析
5957

60-
已执行的优化结果将自动显示在左侧边栏对应工作空间的优化列表中(每个工作空间的最近10个优化)。
6158

6259
## 注意事项
6360

resources/demo.gif

817 KB
Loading

本地启动文档.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@ npm install
22
npm run compile
33
npm run build-webview
44

5+
vsce package
6+
57
F5启动

0 commit comments

Comments
 (0)