Skip to content

Commit 0530190

Browse files
committed
更新文档
1 parent 1975e2c commit 0530190

9 files changed

+151
-59
lines changed

README.md

+70-25
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,64 @@
1-
# Database Client
2-
3-
Database Client for Visual Studio Code. It supports databases MySQL/MariaDB, Microsoft SQL Server, PostgreSQL, SQLite, MongoDB, Redis, and ElasticSearch.
1+
# Database Client for Visual Studio Code
2+
3+
<p align="center">
4+
<a href="https://marketplace.visualstudio.com/items?itemName=cweijan.vscode-mysql-client2">
5+
<img src="https://img.shields.io/vscode-marketplace/v/cweijan.vscode-mysql-client2.svg?label=vscode%20marketplace">
6+
</a>
7+
<a href="https://marketplace.visualstudio.com/items?itemName=cweijan.vscode-mysql-client2">
8+
<img src="https://vsmarketplacebadge.apphb.com/installs-short/cweijan.vscode-mysql-client2.svg">
9+
</a>
10+
<a href="https://github.com/cweijan/vscode-database-client">
11+
<img src="https://img.shields.io/github/stars/cweijan/vscode-database-client?logo=github&style=flat">
12+
</a>
13+
<a href="https://marketplace.visualstudio.com/items?itemName=cweijan.vscode-mysql-client2">
14+
<img src="https://img.shields.io/vscode-marketplace/r/cweijan.vscode-mysql-client2.svg">
15+
</a>
16+
<a href="https://marketplace.visualstudio.com/items?itemName=cweijan.vscode-mysql-client2">
17+
<img alt="GitHub" src="https://img.shields.io/github/license/cweijan/vscode-database-client">
18+
</a>
19+
</p>
20+
<br>
21+
22+
This project is a database client for VSCode, supports manager **MySQL/MariaDB, PostgreSQL, SQLite, Redis, ClickHouse, 达梦**, and **ElasticSearch**, and works as an **SSH** client, boost your maximum productivity!
423

524
> Project site: [vscode-database-client](https://github.com/cweijan/vscode-database-client), [中文文档](README_CN.md)
625
26+
[![Logo](./public/logo_dark.png)](https://database-client.com)
27+
28+
I put a lot of effort into developing this extension, but often receives unfriendly reviews, just because they are not satisfied with a certain feature.
29+
30+
For a free software, this seriously demotivated the author, so I convert it to paid software, you can still using for free, but you cannot use all the features.
31+
732
## Features
833

934
- [Database Client](#database-client)
1035
- [Connect](#connect)
1136
- [Table](#table)
1237
- [Execute SQL Query](#execute-sql-query)
13-
- [Generate Mock Data](#generate-mock-data)
14-
- [History](#history)
1538
- [Backup/Import](#backupimport)
1639
- [Setting](#setting)
1740
- [Filter](#filter)
41+
- [Generate Mock Data](#generate-mock-data)
42+
- [History](#history)
1843

1944
## Installation
2045

2146
Install from vscode marketplace [vscode-database-client](https://marketplace.visualstudio.com/items?itemName=cweijan.vscode-mysql-client2).
2247

2348
## Connect
2449

25-
1. Open Database Explorer panel, then click the`+` button.
50+
1. Open Database Explorer panel, then click the `+` button.
2651
2. Select your database type, input connection config then click the connect button.
2752

2853
![connection](images/connection.jpg)
2954

55+
Two panels are created because in some cases you need to view both SQL and NoSQL data at the same time, you can drag the panel to the other by long-pressing.
56+
3057
## Table
3158

3259
1. Click table to open table view.
33-
2. Then you can do data modification on the view page.
60+
2. Click button beside table to open new table view.
61+
3. Then you can do data modification on the table view.
3462

3563
![query](images/QueryTable.jpg)
3664

@@ -40,52 +68,69 @@ In the Database Explorer panel, click the `Open Query` button.
4068

4169
![newquery](images/newquery.jpg)
4270

43-
That will open a sql editor bind of database, it provider:
71+
That will open a SQL editor bind of database, it provider:
4472

45-
1. IntelliSense sql edit.
73+
1. IntelliSense SQL edit.
4674
2. snippets:`sel、del、ins、upd、joi`...
47-
3. Run selected or current cursor sql (Shortcut : Ctrl+Enter).
48-
4. Run all sql (Shortcut : Ctrl+Shift+Enter).
75+
3. Run selected or current cursor SQL (Shortcut : Ctrl+Enter).
76+
4. Run all SQL (Shortcut : Ctrl+Shift+Enter).
4977

50-
![run](images/run.jpg)
78+
Note: The extension is developed using Nodejs. Nodejs does not allow duplicate name attributes, so you need to avoid columns with the same name in your query, otherwise the results will not be displayed in full.
5179

52-
## Generate Mock Data
80+
![run](images/run.jpg)
5381

54-
You can easily generate test data.
82+
This extension supports codelen, but does not support stored procedures and functions. If you use them frequently, it is recommended to disable codelen
83+
![image](https://user-images.githubusercontent.com/27798227/144196926-e581872e-5392-4744-a646-a644749c548c.png)
5584

56-
![mockData](images/mockData.jpg)
85+
## Cache
5786

58-
## History
87+
In order to improve performance, the database information is cached. If your database structure changes externally, you need to click the refresh button to refresh the cache。
5988

60-
Click the history button to open the list of recently executed query history records.
61-
62-
![history](images/history.jpg)
89+
![](images/1638342622208.png)
6390

6491
## Backup/Import
6592

6693
Move to ant DatabaseNode or TableNode. The export/import options are listed in the context menu (right click to open).
6794

95+
The extension implements the backup function, but it is not stable enough. You can add mysql_dump or pg_dump to the environment variable, and the extension will use these tools for backup.
96+
6897
![bakcup](images/Backup.jpg)
6998

7099
## Setting
71100

72-
This extension contain some setting, find him in the following way.
101+
This extension contain some setting, can be modified as follows.
73102

103+
The default settings can get the best experience, don't worry
104+
105+
![image](https://user-images.githubusercontent.com/27798227/146523121-9de9c708-8a8e-4e3b-ae1d-9da36f3217e1.png)
74106
![](images/1611910592756.png)
75107

76108
## Filter
77109

110+
Used to quickly filter the table, if there is an input box to simplify the search operation, but unfortunately VSCode does not support this function.
111+
78112
![filter](images/filter.gif)
79113

114+
## Generate Mock Data
115+
116+
You can easily generate test data.
117+
118+
![mockData](images/mockData.jpg)
119+
120+
## History
121+
122+
Click the history button to open the list of recently executed query history records.
123+
124+
![history](images/history.jpg)
125+
80126
## Credits
81127

82-
- [vscode-mysql](https://github.com/formulahendry/vscode-mysql): The original version of this extension.
83-
- [mysqldump](https://github.com/bradzacher/mysqldum): Data dump lib.
84128
- [sql-formatter](https://github.com/zeroturnaround/sql-formatter) Sql format lib.
85129
- [umy-ui](https://github.com/u-leo/umy-ui): Result view render.
86-
- Core Lib:
87-
- [node-mysql2](https://github.com/sidorares/node-mysql2) : Mysql client.
88-
- [node-postgres](https://github.com/brianc/node-postgres): PostgreSql client.
130+
- [ssh2](https://github.com/mscdex/ssh2): SSH client.
131+
- Client Lib:
132+
- [node-mysql2](https://github.com/sidorares/node-mysql2) : MySQL client.
133+
- [node-postgres](https://github.com/brianc/node-postgres): PostgreSQL client.
89134
- [tedious](https://github.com/tediousjs/tedious): SqlServer client.
90135
- [ioredis](https://github.com/luin/ioredis): Redis client.
91136
- [vscode-sqlite](https://github.com/AlexCovizzi/vscode-sqlite): SQLite client code reference.

README_CN.md

+81-34
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,42 @@
1-
# Database Client
2-
3-
![Rating](https://vsmarketplacebadge.apphb.com/rating-short/cweijan.vscode-mysql-client2.svg)
4-
5-
该项目为Visual Studio Code的数据库客户端插件, 支持**MySQL/MariaDB, Microsoft SQL Server, PostgreSQL, SQLite, MongoDB, Redis**以及ElasticSearch的管理.
6-
7-
- 功能
8-
- [连接](#连接)
9-
- [数据表](#数据表)
10-
- [执行SQL](#执行SQL)
11-
- [生成测试数据](#生成测试数据)
12-
- [历史记录](#历史记录)
13-
- [备份/导出](#备份/导出)
14-
- [设置](#设置)
15-
- [表过滤](#表过滤)
1+
# Database Client for Visual Studio Code
2+
3+
<p align="center">
4+
<a href="https://marketplace.visualstudio.com/items?itemName=cweijan.vscode-mysql-client2">
5+
<img src="https://img.shields.io/vscode-marketplace/v/cweijan.vscode-mysql-client2.svg?label=vscode%20marketplace">
6+
</a>
7+
<a href="https://marketplace.visualstudio.com/items?itemName=cweijan.vscode-mysql-client2">
8+
<img src="https://vsmarketplacebadge.apphb.com/installs-short/cweijan.vscode-mysql-client2.svg">
9+
</a>
10+
<a href="https://github.com/cweijan/vscode-database-client">
11+
<img src="https://img.shields.io/github/stars/cweijan/vscode-database-client?logo=github&style=flat">
12+
</a>
13+
<a href="https://marketplace.visualstudio.com/items?itemName=cweijan.vscode-mysql-client2">
14+
<img src="https://img.shields.io/vscode-marketplace/r/cweijan.vscode-mysql-client2.svg">
15+
</a>
16+
<a href="https://marketplace.visualstudio.com/items?itemName=cweijan.vscode-mysql-client2">
17+
<img alt="GitHub" src="https://img.shields.io/github/license/cweijan/vscode-database-client">
18+
</a>
19+
</p>
20+
<br>
21+
22+
该项目为Visual Studio Code的数据库客户端扩展, 支持**MySQL/MariaDB, PostgreSQL, SQLite, Redis, ClickHouse, 达梦**以及**ElasticSearch**的管理, 且可以作为一个SSH客户端, 最大程度地提高你的生产力!
23+
24+
<a href="https://database-client.com" target="_blank"><img src="./public/logo_dark.png" alt="Logo" style="height: auto !important;width: auto !important;" ></a>
25+
26+
开发这个扩展我花了大量的精力, 然而时常收到不友好评价, 仅仅是因为这些人对某个功能不满意.
27+
28+
对于一个免费软件, 这严重降低了作者的积极性, 所以我决定将其转为付费软件, 现在用户需要付费才可以使用全部功能, 中国区高级版价格为68元1年, 需反馈问题可加Q群706495803.
29+
30+
## 功能
31+
32+
- [连接](#连接)
33+
- [数据表](#数据表)
34+
- [执行SQL](#执行SQL)
35+
- [备份/导出](#备份/导出)
36+
- [设置](#设置)
37+
- [表过滤](#表过滤)
38+
- [生成测试数据](#生成测试数据)
39+
- [历史记录](#历史记录)
1640

1741
## 安装
1842

@@ -25,49 +49,72 @@
2549

2650
![connection](images/connection.jpg)
2751

52+
创建两个面板是因为部分情况下你需要同时查看SQL和NoSQL的数据, 可通过长按拖动面板到另一个里面.
53+
2854
## 数据表
2955

30-
1. 点击数据库表打开数据视图
31-
2. 之后便可在页面进行CRUD、数据导出(**Excel、JSON**)等操作.![query](images/QueryTable.jpg)
56+
1. 点击数据库表打开数据页, 点击表旁边的按钮则是打开新的数据页.
57+
2. 之后就可在页面进行CRUD、数据导出(**Excel、JSON**)等操作.![query](images/QueryTable.jpg)
3258

3359
## 执行SQL
3460

35-
* 点击数据库节点的`New Query` 按钮.![newquery](images/newquery.jpg)
36-
* 之后可在编辑器中编辑和执行SQL(快捷键 : F9).
37-
* ![run](images/run.jpg)
61+
点击数据库节点的 `Open Query` 按钮.![newquery](images/newquery.jpg)
3862

39-
## 生成测试数据
63+
将会打开新的SQL编辑器, 可编辑和执行SQL, 提供了以下功能
4064

41-
- 该扩展提供一键生成虚拟数据的功能, 再也不用为没有测试数据而烦恼.![mockData](images/mockData.jpg)
65+
1. SQL自动补全.
66+
2. snippets:`sel、del、ins、upd、joi.`
67+
3. 执行已选择或当前光标SQL (快捷键: Ctrl+Enter).
68+
4. 执行全部SQL (快捷键: Ctrl+Shift+Enter).
4269

43-
## 历史记录
70+
注意: 扩展由Nodejs开发, Nodejs不支持同名属性, 所以你需要避免在你的查询中出现同名列, 否则结果无法显示完整.
4471

45-
- 点击历史记录按钮后可查看以往执行的Sql记录.![history](images/history.jpg)
72+
![run](images/run.jpg)
73+
74+
该扩展支持了codelen, 但不支持存储过程和函数, 如果你经常使用他们, 则建议禁用codelen.
75+
![image](https://user-images.githubusercontent.com/27798227/144196926-e581872e-5392-4744-a646-a644749c548c.png)
76+
77+
## 缓存
78+
79+
为了提高性能,缓存了数据库信息,如果你的数据库结构在外部发生了变更,需要点击以下按钮刷新缓存。
80+
81+
![](images/1638342622208.png)
4682

4783
## 备份/导入
4884

49-
* 在表或者数据库节点右击, 之后便可以进行数据的导入导出.![bakcup](images/Backup.jpg)
85+
在表或者数据库节点右击, 之后便可以进行数据的导入导出; 扩展实现了备份功能, 但不够稳定, 可将mysql_dump或pg_dump加到环境变量, 扩展就会使用这些工具进行备份.
86+
87+
![bakcup](images/Backup.jpg)
5088

5189
## 设置
5290

53-
该扩展包含一些设置, 可通过以下方式打开设置界面.
91+
该扩展包含一些设置, 可通过以下方式进行设置, 默认的设置就可以得到最好的使用体验, 不用纠结.
5492

55-
![](images/1611910592756.png)
93+
![img](images/1611910592756.png)
5694

5795
## 表过滤
5896

59-
用于快速筛选数据表.
97+
用于快速筛选表, 如果有输入框可简化搜索操作, 但不幸的是VSCode并不支持该功能.
6098

6199
![filter](images/filter.gif)
62100

63-
# 致谢
101+
## 生成测试数据
102+
103+
- 该扩展提供一键生成虚拟数据的功能, 再也不用为没有测试数据而烦恼.![mockData](images/mockData.jpg)
104+
105+
## 历史记录
106+
107+
- 点击历史记录按钮后可查看以往执行的Sql记录.![history](images/history.jpg)
108+
109+
## 致谢
64110

65-
- [vscode-mysql](https://github.com/formulahendry/vscode-mysql): 本插件的灵感来源
66-
- [mysqldump](https://github.com/bradzacher/mysqldum): 数据备份库.
67111
- [sql-formatter](https://github.com/zeroturnaround/sql-formatter) Sql格式化库.
68112
- [umy-ui](https://github.com/u-leo/umy-ui): 表数据渲染库.
113+
- [ssh2](https://github.com/mscdex/ssh2): SSH连接库.
69114
- 核心连接库:
70115

71-
- [node-mysql2](https://github.com/sidorares/node-mysql2) : Mysql client.
72-
- [node-postgres](https://github.com/brianc/node-postgres): PostgreSql client.
73-
- [tedious](https://github.com/tediousjs/tedious): SqlServer client.
116+
- [node-mysql2](https://github.com/sidorares/node-mysql2) : MySQL连接库.
117+
- [node-postgres](https://github.com/brianc/node-postgres): PostgreSQL连接库.
118+
- [tedious](https://github.com/tediousjs/tedious): SqlServer连接库.
119+
- [ioredis](https://github.com/luin/ioredis): Redis连接库.
120+
- [vscode-sqlite](https://github.com/AlexCovizzi/vscode-sqlite): SQLite连接代码参考.

images/1611910592756.png

-13.1 KB
Loading

images/1638342622208.png

5.51 KB
Loading

images/QueryTable.jpg

4.72 KB
Loading

images/filter.gif

-19.9 KB
Loading

public/icon.png

16.7 KB
Loading

public/logo.png

3.36 KB
Loading

public/logo_dark.png

3.37 KB
Loading

0 commit comments

Comments
 (0)