Skip to content

Commit da81b1b

Browse files
author
lhy
committed
Merge branch 'master' of github.com:Paw-SQL/pawsql-vscode-plguin
2 parents bc88795 + ad7901a commit da81b1b

8 files changed

Lines changed: 7533 additions & 3441 deletions

File tree

README.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,32 @@
22
[English](README.md) | [中文](README_zh-CN.md)
33

44
## Introduction
5-
PawSQL Client enables developers to access core capabilities of the PawSQL directly within their VS Code development environment. PawSQL provides sosophisticated SQL optimization features including smart index recommendations and query rewriting suggestions.. PawSQL Client requires integration with the PawSQL optimization platform (either [PawSQL Cloud](https://pawsql.com) or enterprise private deployment). For comprehensive SQL optimization capabilities, please refer to the [PawSQL Technical Documentation](https://docs.pawsql.com).
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).
66

77
[Watch PawSQL Client Demo](https://www.bilibili.com/video/BV19aDBYAEcr/)
88

99
## Features
10-
- **SQL Optimization**: Get optimization recommendation by one click.
11-
- **Intelligent index recommendation**: Recommend optimal indexes based on input SQL syntax, database objects and statistics information
12-
- **Rewrite Optimization**: Recommend semantically equivalent, but more efficient SQLs
10+
- **Optimize by Clicks**: Get optimization recommendation for your SQL query by one click.
11+
- **Index Advise**: Recommend optimal indexes based on input SQL syntax, database objects and statistics information
12+
- **Query Rewrite**: Recommend semantically equivalent, but more efficient SQLs
1313
- **Performance Validation**: Ensure better performance after SQL rewrite and index recommendation
1414

1515
## Installation
16-
1. Open Visual Studio Code
17-
2. Navigate to Extensions view (`Ctrl+Shift+X` or `Cmd+Shift+X`)
16+
1. Open VS Code
17+
2. Navigate to Extensions (`Ctrl+Shift+X` or `Cmd+Shift+X`)
1818
3. Search for "PawSQL Client" and click Install
1919

2020
## Initial Setup
21-
When using the extension for the first time, complete these configuration steps:
22-
1. Click the PawSQL icon in the VSCode sidebar to access configuration
23-
2. Fill in the following configuration fields:
24-
- Backend URL (e.g., `https://pawsql.com`)
25-
- Frontend URL (e.g., `https://pawsql.com`)
26-
- API Key (Your PawSQL API key, available in the platform's user settings)
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)
2727
3. Click "Save"
2828

29-
Upon successful configuration, the sidebar will load your workspace list (last 100 workspaces at most).
30-
3129
## Usage Guide
32-
### SQL Optimization in VS Code
30+
### Optimize SQLs in VS Code
3331
Two optimization methods are available in SQL files:
3432
1. **Optimize Using Default Workspace**:
3533
- Click the "Optimize" button in the SQL statement prompt
@@ -48,5 +46,4 @@ After optimization completion:
4846
Recent optimization results (last 10 per workspace) automatically appear in the sidebar under their respective workspaces.
4947

5048
## Important Notes
51-
- Ensure PawSQL Backend URL and Frontend URL are accessible
52-
- API Key is your unique identifier for [PawSQL Cloud](https://pawsql.com) or private deployment platform, available in the platform's user settings
49+
- You must have a valid account on the PawSQL Cloud or on a privately deployed PawSQL platform.

README_zh-CN.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,5 +61,4 @@ PawSQL Client让开发者能够在VS Code开发环境中直接使用PawSQL引擎
6161

6262
## 注意事项
6363

64-
- 确保配置的PawSQL的 Backend URL 和 Frontend URL 可以正常访问
65-
- API Key为您在[PawSQL Cloud](https://pawsql.com)或私域部署的PawSQL优化平台上的唯一标识,可以在优化平台的用户设置页面查看
64+
- 您必须在[PawSQL Cloud](https://pawsql.com)或私域部署的PawSQL优化平台有对应的账号

0 commit comments

Comments
 (0)