Skip to content

Commit 2443198

Browse files
cweijancweijan
committed
quick commit
0 parents  commit 2443198

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+352
-0
lines changed

‎.nojekyll

Whitespace-only changes.

‎CNAME

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
doc.database-client.com

‎README.md

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Database Client
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**, and **ElasticSearch**, and works as an **SSH** client, boost your maximum productivity!
23+
24+
![icon](public/logo_dark.png)
25+
26+
## Function Description
27+
28+
Feature comparison of free version and paid premium version:
29+
30+
| Feature | Free | Premium |
31+
| --------------------------------------------- | ---- | ------- |
32+
| Connect to MySQL, PostgreSQL, Redis and More | ✔ | ✔ |
33+
| Connect to SSH server as SSH client | ✔ | ✔ |
34+
| Modify, query table data and database objects | ✔ | ✔ |
35+
| SQL Completion | ✔ | ✔ |
36+
| Database backup and recovery | ✔ | ✔ |
37+
| Unlimited connections(Limit 3 for free.) | ✘ | ✔ |
38+
| More IntelliSense SQL Completion | ✘ | ✔ |
39+
| Workspace level connection | ✘ | ✔ |
40+
| Cloud Config Sync | ✘ | ✔ |
41+
| SFTP Support | ✘ | ✔ |
42+
| Export table data as JSON, CSV, XLSX | ✘ | ✔ |
43+
| Open database terminal. | ✘ | ✔ |
44+
| Show table definition SQL | ✘ | ✔ |
45+
| View SQL execution history | ✘ | ✔ |
46+
47+
## Other
48+
49+
- Install: [vscode-database-client](https://marketplace.visualstudio.com/items?itemName=cweijan.vscode-mysql-client2)
50+
- contact us: If you have any problems in use, you can go to [github](https://github.com/cweijan/vscode-database-client/issues) to create an issue or send an email to [email protected].

‎_navbar.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
* [English](/)
2+
* [中文](/zh/)

‎_sidebar.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
* Document
2+
3+
* [introduce](README.md)
4+
* [Connection](connect.md)
5+
* [Database](database.md)
6+
* [Table](table.md.md)
7+
* [SQL](sql.md)
8+
* [SSH](ssh.md)
9+
* [Console](console.md)
10+
* [Mock Data](mockData.md)

‎connect.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## Connect
2+
3+
1. Open Database Explorer panel, then click the `+` button.
4+
2. Select your database type, input connection config then click the connect button.
5+
6+
![connection](images/connection.jpg)
7+
8+
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.
9+
10+
## Cache
11+
12+
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。
13+
14+
![](images/1638342622208.png)
15+
16+
## Filter
17+
18+
Quickly filter tables, VSCode does not support creating input boxes, so this is the only way.
19+
20+
![filter](images/filter.gif)

‎console.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Console
2+
3+
By clicking this button to open the console, where you can modify extension settings, export and import config, and perform cloud synchronization of connection config
4+
5+
![](image/console/1646791881361.png)
6+
7+
Cloud synchronization can specify an encryption key, and DES encryption and decryption will be performed through the key during cloud synchronization to ensure your data security
8+
9+
![](image/console/1646792025769.png)

‎database.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Database
2+
3+
## Backup/Import
4+
5+
Right-click on a table or database node, and you can backup and restore data through the menu.
6+
7+
The extension has a built-in backup function, but it is not perfect. When your environment variable has **mysql_dump** or **pg_dump**, the extension will use These tools make backups.
8+
9+
![bakcup](images/Backup.jpg)

‎docsify/docsify.min.js

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docsify/vue.css

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎image/console/1646791881361.png

15.7 KB
Loading

‎image/console/1646792025769.png

51.6 KB
Loading

‎image/ssh/1646808779136.png

35.5 KB
Loading

‎image/table/1647004765915.png

119 KB
Loading

‎image/table/design.png

59.4 KB
Loading

‎images/1611910592756.png

24.2 KB
Loading

‎images/1638342622208.png

5.51 KB
Loading

‎images/Backup.jpg

27.6 KB
Loading

‎images/QueryTable.jpg

53.5 KB
Loading

‎images/connection.jpg

44.9 KB
Loading

‎images/filter.gif

297 KB
Loading

‎images/history.jpg

16.3 KB
Loading

‎images/mockData.jpg

47.5 KB
Loading

‎images/newquery.jpg

19 KB
Loading

‎images/run.jpg

10.8 KB
Loading

‎index.html

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<title>Document</title>
6+
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
7+
<meta name="description" content="Description">
8+
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
9+
<link rel="stylesheet" href="docsify/vue.css">
10+
</head>
11+
<body>
12+
<div id="app"></div>
13+
<script>
14+
// https://docsify.js.org/#/zh-cn/configuration
15+
window.$docsify = {
16+
name: '',
17+
repo: '',
18+
maxLevel: 4,
19+
subMaxLevel: 1,
20+
loadSidebar: true,
21+
loadNavbar: true,
22+
alias: {
23+
'/.*/_navbar.md': '/_navbar.md',
24+
// '/en/(.*)': 'https://raw.githubusercontent.com/en/$1'
25+
}
26+
}
27+
</script>
28+
<script src="docsify/docsify.min.js"></script>
29+
</body>
30+
</html>

‎mockData.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
## Generate
2+
3+
Quickly generate data for database testing, generate by following steps:
4+
5+
![mockData](images/mockData.jpg)
6+
7+
Generate Config
8+
9+
- mockStartIndex: Used to populate the primary key, auto means to take the total number of current table data + 1.
10+
- mockCount: The total number of test data you want to generate

‎public/logo_dark.png

3.37 KB
Loading

‎sql.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# SQL
2+
3+
## Execute
4+
5+
In the Database Explorer panel, click the `Open Query` button.
6+
7+
![newquery](images/newquery.jpg)
8+
9+
That will open a SQL editor bind of database, it provider:
10+
11+
1. IntelliSense SQL edit.
12+
2. snippets:`sel、del、ins、upd、joi`...
13+
3. Run selected or current cursor SQL (Shortcut : Ctrl+Enter).
14+
4. Run all SQL (Shortcut : Ctrl+Shift+Enter).
15+
16+
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.
17+
18+
![run](images/run.jpg)
19+
20+
This extension supports codelen, but does not support stored procedures and functions. If you use them frequently, it is recommended to disable codelen
21+
22+
![image](https://user-images.githubusercontent.com/27798227/144196926-e581872e-5392-4744-a646-a644749c548c.png)

‎ssh.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# SSH
2+
3+
This software additionally provides SSH support, which can be used as an SSH client. After creating an SSH connection, it supports the following functions:
4+
5+
1. Terminal: Open the interactive terminal by clicking the button next to the connection
6+
2. SFTP: Expand the SSH connection node to display all files on the server
7+
3. Port forwarding: forward the socket on the server to the local machine
8+
9+
![](image/ssh/1646808779136.png)

‎table.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Table
2+
3+
## View
4+
5+
1. Click table to open table view.
6+
2. Click button beside table will open new table view.
7+
3. Then you can do data modification on the table view.
8+
9+
![query](images/QueryTable.jpg)
10+
11+
## Design
12+
13+
Right-click on the table node, select design table, then you can open the design table interface to view the columns and indexes of the table, or you can directly expand the table, click the column node and edit it directly.
14+
15+
![](image/table/design.png)

0 commit comments

Comments
 (0)