Skip to content

Commit 42a1139

Browse files
committed
Update README.md
1 parent 048bc9d commit 42a1139

1 file changed

Lines changed: 42 additions & 36 deletions

File tree

README.md

Lines changed: 42 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +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-
## PawSQL 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-
## Optimize SQLs
30-
Two optimization methods are available in SQL files:
31-
1. **Optimize Using Default Workspace**:
32-
- Click the "Optimize" button in the SQL statement prompt
42+
MySQL, PostgreSQL, MariaDB, Oracle, openGauss, KingbaseES, GaussDB, Dameng, RDS for MySQL and etc.
3343

34-
2. **Optimize Using Specific Workspace**:
35-
- Click the "Optimize..." button in the SQL statement prompt
36-
- Select a workspace from the dropdown menu
44+
<br/>
45+
46+
## Resources
3747

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
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>
4552

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

0 commit comments

Comments
 (0)