Skip to content

Commit a47a0c2

Browse files
committed
Merge branch 'main'
2 parents 900e1ac + 42a1139 commit a47a0c2

3 files changed

Lines changed: 50 additions & 48 deletions

File tree

README.md

Lines changed: 42 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,53 @@
1-
# PawSQL Client
2-
[English](README.md) | [中文](README_zh-CN.md)
31

4-
## Introduction
5-
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).
2+
<div align="center">
3+
<h1>
4+
<picture>
5+
<source srcset="https://github.com/Paw-SQL/pawsql-vscode/raw/main/resources/logo.png" media="(prefers-color-scheme: dark)"/>
6+
<img src="https://github.com/Paw-SQL/pawsql-vscode/raw/main/resources/logo.png" width=600 />
7+
68

7-
![PawSQL Client Demo](/resources/demo.gif)
9+
</picture>
10+
11+
<br/>
12+
</h1>
13+
14+
<h3><a href="https://aiven.io">PawSQL</a> , Optimize your SQL Queries by Clicks! </h3>
15+
16+
[![Version](https://img.shields.io/visual-studio-marketplace/v/PawSQL.pawsqlClient?style=for-the-badge&color=%23e38a14
17+
)](https://marketplace.visualstudio.com/items?itemName=PawSQL.pawsqlClient)
18+
[![Ratings](https://img.shields.io/visual-studio-marketplace/r/PawSQL.pawsqlClient?style=for-the-badge&color=%23e38a14)](https://marketplace.visualstudio.com/items?itemName=PawSQL.pawsqlClient)
19+
20+
<br/>
21+
22+
<picture>
23+
<source srcset="https://github.com/Paw-SQL/pawsql-vscode/raw/main/resources/demo.gif" media="(prefers-color-scheme: dark)"/>
24+
<img src="https://github.com/Paw-SQL/pawsql-vscode/raw/main/resources/demo.gif" width=800 />
25+
</picture>
26+
<br/>
27+
28+
## Optimize a SQL Query
29+
1. **Optimize in Default Workspace**:
30+
- Click the "Optimize" button in the SQL statement prompt
31+
32+
2. **Optimize in Specific Workspace**:
33+
- Click the "Optimize..." button in the SQL statement prompt
34+
- Select a workspace from the dropdown menu
835

936
## Features
10-
- **Optimize by Clicks**: Get optimization recommendation for your SQL query by one click.
1137
- **Index Advise**: Recommend optimal indexes based on input SQL syntax, database objects and statistics information
1238
- **Query Rewrite**: Recommend semantically equivalent, but more efficient SQLs
1339
- **Performance Validation**: Ensure better performance after SQL rewrite and index recommendation
40+
## Supported Databases
1441

15-
## Installation
16-
1. Open VS Code
17-
2. Navigate to Extensions (`Ctrl+Shift+X` or `Cmd+Shift+X`)
18-
3. Search for "PawSQL Client" and click Install
19-
20-
## Initial Setup
21-
You need to do some initial setup before your start to use PawSQL Client:
22-
1. Click the PawSQL icon on the VSCode sidebar
23-
2. Fill in the following fields:
24-
- PawSQL Server Address (e.g., `https://pawsql.com`)
25-
- PawSQL Account (your account on PawSQL Server)
26-
- Password (password of your account)
27-
3. Click "Save"
28-
29-
## Usage Guide
30-
### Optimize SQLs in VS Code
31-
Two optimization methods are available in SQL files:
32-
1. **Optimize Using Default Workspace**:
33-
- Click the "Optimize" button in the SQL statement prompt
34-
2. **Optimize Using Specific Workspace**:
35-
- Click the "Optimize..." button in the SQL statement prompt
36-
- Select a workspace from the dropdown menu
42+
MySQL, PostgreSQL, MariaDB, Oracle, openGauss, KingbaseES, GaussDB, Dameng, RDS for MySQL and etc.
43+
44+
<br/>
3745

38-
### Optimization Results
39-
After optimization completion:
40-
- Results are displayed in VSCode's WebView
41-
- Click "View Detailed Optimization in Browser" for additional information, including:
42-
- SQL comparison
43-
- Execution plan comparison
44-
- Detailed analysis
46+
## Resources
4547

46-
Recent optimization results (last 10 per workspace) automatically appear in the sidebar under their respective workspaces.
48+
<p><a href="https://docs.pawsql.com">PawSQL Docs</a></p>
49+
<p><a href="https://pawsql.com/app">PawSQL Optimizer</a></p>
50+
<p><a href="https://pawsql.com/ppt">PawSQL Performance Patroller</a></p>
51+
<p><a href="https://pawsql.com/ppv">PawSQL Plan Visualizer</a></p>
4752

48-
## Important Notes
49-
- You must have a valid account on the PawSQL Cloud or on a privately deployed PawSQL platform.
53+
<br/>

README_zh-CN.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,19 +33,18 @@ PawSQL Client让开发者能够在VS Code开发环境中直接使用PawSQL引擎
3333
- Password (PawSQL Server账号的密码)
3434
3. 点击"保存"按钮
3535

36-
## 使用说明
37-
38-
### 在VS Code环境中进行SQL 优化
36+
## 在VS Code环境中进行SQL 优化
3937

4038
在 SQL 文件中提供两种优化方式:
4139

42-
1. **使用默认工作空间执行优化**
40+
1. **使用默认工作空间优化SQL**
4341
- 在 SQL 语句上方的提示中点击"Optimize"按钮
44-
2. **选择特定工作空间优化**
42+
43+
2. **选择特定工作空间优化SQL**
4544
- 点击 SQL 语句提示中的"Optimize..."按钮
4645
- 从弹出的下拉列表中选择工作空间,进行优化
4746

48-
### 查看优化结果
47+
## 查看优化结果
4948

5049
优化完成后:
5150

@@ -55,7 +54,6 @@ PawSQL Client让开发者能够在VS Code开发环境中直接使用PawSQL引擎
5554
- 执行计划对比
5655
- 其他详细分析
5756

58-
59-
## 注意事项
57+
**注意事项**
6058

6159
- 您必须在[PawSQL Cloud](https://pawsql.com)或私域部署的PawSQL优化平台有对应的账号

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -257,9 +257,9 @@
257257
},
258258
"repository": {
259259
"type": "git",
260-
"url": "https://github.com/Paw-SQL/pawsql-vscode-plugin.git"
260+
"url": "https://github.com/Paw-SQL/pawsql-vscode.git"
261261
},
262262
"bugs": {
263-
"url": "https://github.com/Paw-SQL/pawsql-vscode-plugin/issues"
263+
"url": "https://github.com/Paw-SQL/pawsql-vscode/issues"
264264
}
265265
}

0 commit comments

Comments
 (0)