Sqlens — VS Code 数据库客户端 & MCP

English | 简体中文

Sqlens 是一个完全免费的 VS Code 扩展，用于浏览数据库、运行 SQL、编辑表数据、管理本地 SQLite 文件，并内置 MCP 服务器，让 AI 助手（CodeBuddy、Trae、GitHub Copilot 等）也能查询你的数据库。

支持 VS Code 及其衍生 IDE（如 Trae），界面语言自动跟随编辑器显示语言（英文 / 简体中文）。

功能

• 在 Sqlens 侧边栏管理数据库连接。
• 连接 MySQL / MariaDB、PostgreSQL、SQLite 数据库。
• 连接 ClickHouse（列式，HTTP 8123）、Elasticsearch（REST 请求编辑器）、MongoDB（mongosh 风格命令）、SQL Server（T-SQL）数据库。
• 连接 Redis 数据库（standalone / cluster / sentinel，支持 SSH 隧道与 TLS）。
• 内置 SQLite 查看器，直接打开 .db、.sqlite、.sqlite3 文件。
• 连接配置可导出/导入为 JSON 文件（默认不含密码，可选明文并二次确认），方便换机迁移。
• 连接导入支持多种格式（自动嗅探）：sqlens JSON、标准连接 URI（mysql:// / postgres:// / redis:// 等）、CSV/TSV 网格（从 Excel/飞书复制连接清单直接粘贴，中英文表头均可）、.env 文件、Spring application.yml / application.properties 数据源配置，以及 DBeaver / DataGrip（Copy Settings）/ Navicat（.ncx）/ TablePlus 导出的一键迁移；两步导入向导支持预览确认，密码不在导出中的一律置空并提示。
• 双击侧边栏中未连接的连接即可连接（单击仅选中）。
• 浏览库、表、视图、列、索引、外键；双击连接下的数据库可切换为当前活动库（单击仅选中）。
• Queries 侧边栏（原 Saved SQL）保存带所属连接的查询，标题栏「新建」图标可创建查询。
• Schema 面板：内联筛选（* / ? 通配符）、就地重命名表、一键复制表（结构 + 数据）、完整悬浮提示，以及按驱动能力显示的右键菜单。
• 可编辑数据表格（排序、筛选、分页、行内编辑）。
• 在 .sql 文件中通过 CodeLens 运行查询，支持按文件选择连接和数据库上下文。
• 行/页数据复制为 CSV、TSV、JSON、XML、SQL INSERT / UPDATE。
• 内嵌 Quick View 侧栏查看行详情和长文本。
• 可视化建表和改表结构，自动生成 SQL 批次。
• 新建数据库、修改 MySQL/MariaDB 字符集与排序规则、整库导出导入。
• 表数据导入导出、ER 图、查询执行计划。
• 项目级连接配置 .sqlens.json、SSH 隧道、.env 自动识别。
• 连接配置在本机所有 VS Code 系 IDE 之间共享（可选）。
• 查询结果可视化：任意结果表格一键生成柱状 / 折线 / 饼图并导出 PNG。
• AI 查询结果进表格：AI 通过 MCP 执行的只读查询，结果以只读表格出现在结果面板，可从 AI 活动一键跳回；同一 SQL 合并到同一页签。
• 表 / 列注释透给 AI：AI 可读取表与列注释，并按注释搜索，写出更准确的 SQL。
• 保存为查询 / 仪表盘：把结果保存为查询，或把查询 / 图表钉到仪表盘卡片网格（手动刷新、持久化）。
• 界面支持英文和简体中文，自动跟随编辑器语言。

支持的数据库

各驱动的查询写法

Sqlens 直接复用同一个编辑器/结果面板，但每种连接的查询文本不同：

MySQL / MariaDB / PostgreSQL / SQLite / ClickHouse

SELECT id, name FROM users WHERE status = 'active' ORDER BY id LIMIT 100;

SQL Server

SELECT TOP 100 id, name FROM dbo.users ORDER BY id;
-- 或分页：ORDER BY id OFFSET 0 ROWS FETCH NEXT 100 ROWS ONLY

Elasticsearch（Kibana Dev Tools 风格：首行 METHOD /路径，空行后是 JSON body；只写 JSON 则视为搜索）

GET /my-index/_search
{
  "query": { "match": { "title": "error" } },
  "sort": [{ "@timestamp": "desc" }],
  "size": 100
}

聚合结果会按桶展开成行，并附带 bar 条形列便于观察分布。

MongoDB（mongosh 风格，支持 ObjectId('...') / ISODate('...')；不会执行任意 JS）

db.orders.find({ status: 'PAID' }).sort({ createdAt: -1 }).limit(100)
db.orders.countDocuments({ status: 'PAID' })
db.orders.aggregate([{ $group: { _id: '$status', n: { $sum: 1 } } }])
db.orders.updateOne({ _id: ObjectId('...') }, { $set: { status: 'PAID' } })

Redis（每行一条命令）

SCAN 0 MATCH user:* COUNT 100
HGETALL user:1

快速开始

1. 从 VS Code 插件市场 安装。
2. 打开活动栏中的 Sqlens 视图。
3. 点击 新建连接，选择数据库类型并填写连接信息。
4. 点击 测试，然后 保存 并 连接。

code --install-extension wwenc6621.sqlens-vscode

手动安装 VSIX：参见 INSTALL_VSIX.md。

MCP 服务器（供 AI 助手使用）

Sqlens 内置本地 MCP（Model Context Protocol）服务器。启动后，CodeBuddy、Trae、Trae CN、GitHub Copilot 等 AI 助手可以通过你保存的连接列出表、执行只读查询，也可以（可选）执行写入操作。

1. 启用服务器

扩展激活时 MCP 服务器会自动启动（默认开启）。相关设置：

2. 注册到 AI 助手

点击侧边栏标题栏的 Register MCP Server to AI Assistants... 按钮（或运行同名命令）：

在弹出的列表中选择要注册的 AI 助手（可多选），已注册的会打勾提示：

侧边栏标题栏的 MCP 按钮点击可打开 MCP 服务器面板，再次点击则关闭。面板中可以查看运行状态、端点与令牌，并通过两个开关控制访问：Read & Write（打开 = 允许写入，对应 sqlens.mcp.readOnly 关闭；关闭 = 只读，默认）与 Auto Approve（打开 = 写操作不再逐次确认，对应 writeMode: allow；只读模式下不可用，详细说明见开关的悬浮提示）。面板还列出已注册的 AI 助手，并支持一键复制完整的 MCP 配置 JSON：

Sqlens 只写入自己的 sqlens 条目，不影响其他配置：

注册后请重启助手的会话窗口。也可以通过 Sqlens: 复制 MCP 配置片段 手动复制，格式如下：

{
  "mcpServers": {
    "sqlens": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "http://127.0.0.1:37421/mcp"],
      "env": { "MCP_TOKEN": "<你的令牌>" }
    }
  }
}

3. 安全模型

• 服务器只监听 127.0.0.1，并使用本机安装唯一的令牌保护。
• readOnly 模式下，AI 助手的写入语句会被直接拒绝。
• confirm 写入模式下，每次写入请求都会在 AI 活动 面板中弹出确认卡片；所有 AI 调用都会记录在该面板中（sqlens.mcp.showActivity）。
• 需要确认时，Sqlens 会主动切到 AI 活动 面板并显示确认卡片，避免确认请求在后台超时被自动拒绝（sqlens.mcp.focusOnConfirm、sqlens.mcp.autoConfirmTimeout 可调）。
• writeMode: allow 时 INSERT/UPDATE/DELETE/CREATE/ALTER 直接执行；DROP、TRUNCATE 和破坏性管理命令在任何模式下都被拦截。

跨 IDE 共享连接

默认情况下，Sqlens 把连接保存到统一的共享配置文件中，在 VS Code 里创建的连接会自动出现在同机的 Trae 等 IDE 中：

• macOS / Linux：~/.config/sqlens/connections.json
• Windows：%APPDATA%\sqlens\connections.json

如需按 IDE 隔离存储，关闭 sqlens.sharedConnections 即可。

SQLite 文件

Sqlens 为 *.db、*.sqlite、*.sqlite3 注册了自定义编辑器。工作区扫描会自动导入项目中的 SQLite 文件（排除 node_modules、.git、dist、build 等目录）。

查询工作流

打开或新建 .sql 文件后可以使用：

• 语句上方的 运行 CodeLens，或 运行全部语句。
• 更改查询数据库上下文 选择目标连接/数据库。
• 新建查询 基于活动连接创建 SQL 文档。
• 编辑器右键菜单中的 格式化 SQL、查询历史、查看执行计划。

Schema 面板

Sqlens 侧边栏的 Schema 视图列出活动连接的表与视图（目前只包含这两类对象，不含函数 / 存储过程 / 触发器 / 序列）：

• 默认展开：表与视图分组连上连接后自动展开；你手动折叠过的分组在刷新后保持折叠，切换连接时恢复默认。
• 内联筛选：点击标题栏的筛选图标，输入框就地展开（不是弹窗），边输入边过滤；支持 * / ? 通配符和 schema.table 写法，右侧显示 匹配 / 总数。Esc 或再点一次图标即收起。
• 就地重命名：右键表 → 重命名，表名那一行直接变成输入框；回车提交、Esc 取消，名称非法时就地提示原因。
• 悬浮提示：鼠标停留即可查看表的类型 / 行数 / 大小 / 存储引擎 / 注释，字段的类型 / 是否可空 / 默认值 / 长度 / 主键 / 外键 / 注释。
• 右键菜单：打开表、查看结构、查看 DDL、复制 CREATE TABLE、生成测试数据、导出 / 导入数据、重命名、清空表、删除表；只显示当前驱动支持的操作，危险操作标红，点击别处或按 Esc 自动关闭。
• 视图标题栏提供 筛选 / 新建表 / 刷新 三个按钮。

结构编辑

• 结构视图标题栏的 新建数据表。
• 表右键菜单的 编辑表结构：列、索引、外键、重命名、字符集。
• 多个标签页生成的 SQL 会合并到同一个预览中，一次性执行。
• 生成的 SQL 在执行前可以手动修改。

数据表格

• 服务端分页、排序、WHERE 筛选、SQL 级列筛选。
• 列筛选操作符根据列类型自动选择；可在输入前缀（>、>=、~、^、$、=…）覆盖。
• 列 按钮可自定义列的显示/隐藏/顺序，并可按表记住布局。
• 行内编辑带 SQL 预览、应用/放弃，行新增/复制/删除。
• 底部活动日志记录表格操作，出错时包含失败 SQL 便于排查。

快捷键

设置

安全说明

• 密码通过 VS Code SecretStorage 存储（开启共享时写入共享配置文件，文件权限为 0600）。
• 写入查询默认启用安全模式确认。
• 执行生成的 SQL 前，请先检查内容。
• MCP 服务器仅监听本地并有令牌保护；除非需要 AI 写入，建议保持 readOnly 开启。

开发

npm install && (cd webview-ui && npm install)
npm run build        # 构建扩展 + webview
npm run compile:tests
npm run package      # 生成 .vsix

致谢

本项目基于开源项目 TablePro（tablepro-vscode）改造并补充完善，感谢原作者的开源贡献。

支持作者

Sqlens 完全免费开源。如果它帮你节省了时间，欢迎到爱发电为我发电：

许可证

MIT