# vscode-database-client

**Repository Path**: retire/vscode-database-client

## Basic Information

- **Project Name**: vscode-database-client
- **Description**: No description available
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-11-14
- **Last Updated**: 2025-12-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Database Client (数据库客户端)

<div align="center">
    <img src="https://gitee.com/retire/vscode-database-client/raw/main/resources/logo.png" width="128" alt="Database Client Logo" />
    <p>
    一款强大的 VS Code 数据库客户端扩展，支持多种数据库、NoSQL、SSH 及 FTP。
    </p>
    <p>
      <a href="https://marketplace.visualstudio.com/items?itemName=wuyifeng.vscode-database-client"><img src="https://img.shields.io/visual-studio-marketplace/v/wuyifeng.vscode-database-client?style=flat-square&label=VS%20Code%20Marketplace" alt="VS Code Marketplace" /></a>
    <a href="https://marketplace.visualstudio.com/items?itemName=wuyifeng.vscode-database-client"><img src="https://img.shields.io/visual-studio-marketplace/d/wuyifeng.vscode-database-client?style=flat-square" alt="Installs" /></a>
    </p>
    <p>
        <a href="README.md">English</a> | <a href="README_CN.md">简体中文</a>
    </p>
</div>

## ✨ 核心特性

- **多数据库支持**：MySQL, MariaDB, PostgreSQL, Oracle, SQL Server, SQLite, TiDB, OceanBase。
- **国产数据库**：达梦 (Dameng), 人大金仓 (Kingbase), OpenGauss。
- **NoSQL 与服务**：Redis, MongoDB, ElasticSearch。
- **远程管理**：内置 SSH 隧道与客户端，支持 FTP/SFTP 文件管理。
- **数据管理**：可视化表数据查看、分页、筛选、排序，支持导出 Excel/JSON。
- **智能 SQL**：自动补全、语法高亮、格式化与快捷执行。
- **可视化操作**：表结构设计、视图/函数/触发器/用户管理。
- **实用工具**：服务器状态监控、SQL 执行历史、模拟数据生成、随机密码生成器。

## 🚀 快速开始

1. **安装**：在 VS Code 扩展市场搜索 `Database Client` 并安装。
![install](https://gitee.com/retire/vscode-database-client/blob/main/images/install.png)
2. **打开视图**：点击活动栏（Activity Bar）上的数据库图标。
![add](https://gitee.com/retire/vscode-database-client/blob/main/images/add.png)
3. **新建连接**：点击 `+` 号，选择数据库类型并填写连接信息。
![connection](https://gitee.com/retire/vscode-database-client/blob/main/images/connection.png)
   - *提示*：支持 SSH 隧道连接，保障数据安全；新增密码显示切换按钮。
4. **执行查询**：打开 SQL 文件或右键数据库节点选择 "Open Query"。
![run](https://gitee.com/retire/vscode-database-client/blob/main/images/run.png)
   - **执行选中/当前**：`Ctrl + Enter` (Mac: `Cmd + Enter`)
   - **执行全部**：`Ctrl + Shift + Enter` (Mac: `Cmd + Shift + Enter`)

## 🔌 支持列表

| 分类 | 数据库 / 服务 |
|------|-------------------|
| **关系型数据库** | MySQL, MariaDB, PostgreSQL, Oracle, SQL Server, SQLite, TiDB, OceanBase |
| **国产数据库** | 达梦 (DM), 人大金仓 (Kingbase), OpenGauss |
| **NoSQL** | Redis, MongoDB, ElasticSearch |
| **远程/文件** | SSH (Shell/SFTP), FTP |

## ⚙️ 常用配置

您可以在 VS Code 设置 (`Ctrl + ,`) 中搜索 `database-client` 进行个性化配置。
![setting](https://gitee.com/retire/vscode-database-client/blob/main/images/setting.png)
| 配置项 | 说明 |
|---------|-------------|
| `database-client.defaultSelectLimit` | 查询结果默认行数限制 (默认: 200) |
| `database-client.preferConnectionName` | 在树视图中优先显示连接名称而非 Host |
| `database-client.pool.enabled` | 启用连接池 (PG/Oracle/DM) |
| `database-client.highlightSQLBlock` | 编辑器中高亮当前执行的 SQL 块 |
| `database-client.functions` | 注册自定义函数以支持自动补全 |


## 🔧 Tools

- **服务状态**: 数据库状态监控.
![status](https://gitee.com/retire/vscode-database-client/blob/main/images/status.png)
- **执行历史**: 执行历史记录管理.
![history](https://gitee.com/retire/vscode-database-client/blob/main/images/history.png)
- **模拟数据**: 模拟数据生成.
- **随机密码**: 随机密码生成器.
![tool](https://gitee.com/retire/vscode-database-client/blob/main/images/tool.png)

## ⌨️ 快捷键与命令

- **执行 SQL**：`Ctrl + Enter`
- **格式化 SQL**：`Shift + Alt + F`
- **所有命令**：按 `F1` 输入 `db.` 查看（旧版 `mysql.` 命令已迁移至 `db.`）。
  - `db.connection.add`：新建连接
  - `db.history.open`：查看历史记录
  - `db.tools.open`：打开工具箱（随机密码等）

## 🤝 贡献与反馈

欢迎提交 Issue 或 Pull Request！
- [Gitee 仓库 (国内)](https://gitee.com/retire/vscode-database-client)

## 📄 许可证

MIT