diff --git a/README.md b/README.md index 4d3caa3..3af5107 100644 --- a/README.md +++ b/README.md @@ -4,30 +4,27 @@ Database Client For Visual Studio Code -> Supported databases: Mysql/MariaDB、SqlServer、Postgresql -> +English|[中文文档](README_CN.md) + +> Supported databases: Mysql/MariaDB、SqlServer、Postgresql、Redis、ElasticSearch +> > Project site: [vscode-database-client](https://github.com/cweijan/vscode-database-client) **Features** - [Database Client](#database-client) - [Connect](#connect) - - [View Tables](#view-tables) - - [Execute Sql](#execute-sql) + - [Table](#table) + - [Execute SQL](#execute-SQL) - [Generate Mock Data](#generate-mock-data) - [History](#history) - [Backup/Import](#backupimport) - - [Setting](#setting) - [Filter](#filter) ## Installation Install from vscode marketplace [vscode-mysql](https://marketplace.visualstudio.com/items?itemName=cweijan.vscode-mysql-client2). -## Coffee - -If you like this this extension, consider [buying me a coffee](https://www.buymeacoffee.com/cweijan). Thank you! - ## Connect 1. Open MySQL Panel, then click the `+` button. @@ -35,20 +32,18 @@ If you like this this extension, consider [buying me a coffee](https://www.buyme ![connection](images/connection.jpg) -## View Tables +## Table -1. Click Table To Open Query page and Load data. -2. You can do data modification on query page. +1. Click table to open table view. +2. Then you can do data modification on view page. ![query](images/QueryTable.jpg) -## Execute Sql +## Execute SQL * In the MySQL Panel, click the `New Query` button. ![newquery](images/newquery.jpg) -* This changes the active database. -* Now you can enjoy Intellisense for SQL code within the editor. -* Click Run Button or Press `F9` to Execute. - ![run](images/run.jpg) +* Now you can edit and run SQL within the editor. +* ![run](images/run.jpg) ## Generate Mock Data @@ -65,18 +60,6 @@ If you like this this extension, consider [buying me a coffee](https://www.buyme * Move to ant DatabaseNode or TableNode, backup/import options are listed in the context menu (right click to open). ![bakcup](images/Backup.jpg) -## Setting - -OpenSetting -> extensions -> Mysql - -![Setting](images/setting.png) - -## Other - -* Find a suprise when you right click on a node. - -![suprise](images/surprise.jpg) - ## Filter ![filter](images/filter.gif) diff --git a/README_CN.md b/README_CN.md new file mode 100644 index 0000000..6ab395d --- /dev/null +++ b/README_CN.md @@ -0,0 +1,75 @@ +# Database Client + +[![Marketplace Version](https://vsmarketplacebadge.apphb.com/version-short/cweijan.vscode-mysql-client2.svg)](https://marketplace.visualstudio.com/items?itemName=cweijan.vscode-mysql-client2) [![Installs](https://vsmarketplacebadge.apphb.com/installs-short/cweijan.vscode-mysql-client2.svg)](https://marketplace.visualstudio.com/items?itemName=cweijan.vscode-mysql-client2) [![Rating](https://vsmarketplacebadge.apphb.com/rating-short/cweijan.vscode-mysql-client2.svg)](https://marketplace.visualstudio.com/items?itemName=cweijan.vscode-mysql-client2) + +Database Client For Visual Studio Code + +[English](README.md)|中文文档 + +> 支持的数据库: Mysql/MariaDB、SqlServer、Postgresql、Redis、ElasticSearch + +**Features** + +- [Database Client](#database-client) + - [连接](#连接) + - [数据表](#数据表) + - [执行SQL](#执行SQL) + - [生成测试数据](#生成测试数据) + - [历史记录](#历史记录) + - [备份/导出](#备份/导出) + - [表过滤](#表过滤) + +## 安装 + +在 Visual Studio Code 扩展中心安装 [vscode-mysql](https://marketplace.visualstudio.com/items?itemName=cweijan.vscode-mysql-client2). + +## 连接 + +1. 打开左侧数据库面板, 点击添加按钮 +2. 在连接页面配置相应的数据库信息 + +![connection](images/connection.jpg) + +## 数据表 + +1. 点击数据库表打开数据视图 +2. 之后便可在页面进行CRUD、数据导出等操作. + ![query](images/QueryTable.jpg) + +## 执行SQL + +* 点击数据库节点的 `New Query` 按钮. + ![newquery](images/newquery.jpg) +* 之后可在编辑器中编辑和执行SQL. +* ![run](images/run.jpg) + +## 生成测试数据 + +- 该扩展提供一键生成虚拟数据的功能, 再也不用为没有测试数据而烦恼. + ![mockData](images/mockData.png) + +## 历史记录 + +- 点击历史记录按钮后可查看以往执行的Sql记录. + ![history](images/history.jpg) + +## 备份/导出 + +* 在表或者数据库节点右击, 之后便可以进行数据的导入导出. + ![bakcup](images/Backup.jpg) + +## 表过滤 + +![filter](images/filter.gif) + +# 致谢 + +- [vscode-mysql](https://github.com/formulahendry/vscode-mysql): 本插件的灵感来源 +- [mysqldump](https://github.com/bradzacher/mysqldum): 数据备份库. +- [sql-formatter](https://github.com/zeroturnaround/sql-formatter) Sql格式化库. +- [umy-ui](https://github.com/u-leo/umy-ui): 表数据渲染库. +- 核心连接库: + + - [node-mysql2](https://github.com/sidorares/node-mysql2) : Mysql client. + - [node-postgres](https://github.com/brianc/node-postgres): PostgreSql client. + - [tedious](https://github.com/tediousjs/tedious): SqlServer client. diff --git a/images/Backup.jpg b/images/Backup.jpg index 288c023..ba38743 100644 Binary files a/images/Backup.jpg and b/images/Backup.jpg differ diff --git a/images/QueryTable.jpg b/images/QueryTable.jpg index 881caa7..e7afd6c 100644 Binary files a/images/QueryTable.jpg and b/images/QueryTable.jpg differ diff --git a/images/run.jpg b/images/run.jpg index 8c9e03a..7d90eac 100644 Binary files a/images/run.jpg and b/images/run.jpg differ diff --git a/images/setting.png b/images/setting.png deleted file mode 100644 index cf7c0a5..0000000 Binary files a/images/setting.png and /dev/null differ diff --git a/images/surprise.jpg b/images/surprise.jpg deleted file mode 100644 index 4eab806..0000000 Binary files a/images/surprise.jpg and /dev/null differ