wehub-resource-sync
4eccf381cc
25 KiB
Note
本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。
English · 原始项目 · 上游 README
原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。
为什么选择 DBX？
🪶 20 MB，极致轻量无需 Java 运行环境，无需 Python 虚拟环境，不内嵌 Chromium。DBX 是单个小巧的二进制文件——下载、安装、连接。DBeaver 依赖 Java；TablePlus 仅限 macOS。DBX 全平台可用，无需额外运行时。 |
🤖 AI 原生集成在编辑器里选中一张表，描述你想要什么，直接得到 SQL——无需在工具之间复制粘贴。支持 Claude、OpenAI，或通过 Ollama 使用本地模型。内置安全检查会在执行前审查 AI 生成的 SQL。 |
🔌 MCP 协议：你的数据库，AI 就绪DBX 原生支持 Model Context Protocol。Claude Code、Cursor、Windsurf 等 AI 编程助手可以直接通过你已配置的数据库连接查询数据。一次配置，处处可用。 |
🌐 桌面端 + Docker + WebmacOS、Windows、Linux 原生应用。通过 Docker 自托管供团队访问。Web 版本适配纯浏览器环境。同样的功能，同样的连接配置。 |
功能特性
60+ 种数据库，一个工具搞定
MySQL、PostgreSQL、SQLite、Cloudflare D1、Redis、MongoDB、DuckDB、ClickHouse、SQL Server、Oracle、Elasticsearch、MariaDB、TiDB、OceanBase、openGauss、GaussDB、KWDB、KingBase、Vastbase、GoldenDB、Doris、SelectDB、StarRocks、Manticore Search、Redshift、DM、TDengine、虚谷 XuguDB、CockroachDB、Access、HighGo 等数据库都能直接连接。Agent/JDBC 方向的配置还可扩展到 H2、Snowflake、Trino、Hive、DB2、Informix、Neo4j、Cassandra、BigQuery、Kylin、SunDB 和自定义 JDBC。新增的原生与 Agent 驱动还覆盖了 Databricks、SAP HANA、Teradata、Vertica、Firebird、Exasol、崖山 YashanDB、GBase、Databend、RQLite、Turso、InfluxDB、QuestDB、IoTDB、etcd、IRIS 等。全部装进约 20 MB 的应用里，不内嵌 Chromium。
查询编辑器
CodeMirror 6 语法高亮、元数据感知自动补全、Cmd+Enter 执行、选中 SQL 执行、SQL 格式化、诊断提示，9 种编辑器主题。查询历史、常用 SQL 片段、标签页恢复和 SQL 文件执行让重复工作更顺手。
AI SQL 助手
用自然语言描述你的需求，直接生成 SQL。还能解释查询、优化 SQL、修复错误，并通过内置安全检查执行 AI 生成的 SQL。支持 Claude、OpenAI、本地模型或任何 OpenAI 兼容端点。
数据表格
虚拟滚动，轻松应对大型结果集。行内编辑、保存前 SQL 预览、WHERE / ORDER BY 控件、DataGrip 风格过滤器、LIKE / NOT LIKE 右键过滤、排序、全文搜索、分页、列宽调整、自动列宽、行号、斑马纹和完整单元格详情。支持导出或复制为 CSV、JSON、Markdown、XLSX、INSERT 语句。
Schema 工具
- 结构浏览 — 数据库、Schema、表、字段、索引、外键、触发器，支持侧边栏搜索和置顶
- 对象浏览 — 按类型分组查看过程、函数、视图，并在支持的数据库中编辑源码
- 表结构编辑器 — 对支持的数据库执行可审查的字段和索引变更
- ER 关系图 — 可视化表间关联
- Schema 对比 — 跨连接对比表结构差异
- 执行计划 — 可视化查询执行计划
- 字段血缘 — 字段级血缘分析
- 数据库搜索 — 在大型 Schema 中快速查找对象
数据操作
- 数据导入 — CSV、Excel
- 数据迁移 — 在数据库之间迁移数据
- 数据库导出 — 完整数据库导出
- 数据对比 — 对比表数据并审查同步结果
- SQL 文件执行 — 直接执行
.sql文件 - 文件预览 — 拖入 Parquet、CSV、JSON 即时预览（基于 DuckDB）
- 连接导入 — 从 DBeaver 或 Navicat 导入连接配置
专项浏览器
- Redis — 模式匹配搜索、批量键操作、命令执行器、TTL 编辑，全数据类型支持（String、Hash、List、Set、ZSet、Stream）
- MongoDB — 文档增删改查、分页浏览，支持 Atlas 和副本集 URL 直连
安全与连接
SSH 隧道（密钥和密码认证）· 数据库和 AI 代理设置 · 断线自动重连 · 危险操作确认对话框 · 加密导出/导入连接配置 · 连接颜色标记 · 驱动商店与可选 JDBC 插件
精致 UI
深色模式原生标题栏同步 · 9 种编辑器主题 · English、简体中文、Español · 布局偏好设置 · 内置自动更新
AI 编程助手集成 (MCP)
DBX 提供 MCP Server，让 AI 编程助手直接使用 DBX 中已配置的数据库连接查询数据。
npx @dbx-app/mcp-server
在 .mcp.json 中添加：
{
"mcpServers": {
"dbx": { "command": "npx", "args": ["-y", "@dbx-app/mcp-server"] }
}
}
Windows 便携版需要在 MCP 配置中设置 DBX_DATA_DIR，指向 DBX.exe 同级的 data 目录（即包含 dbx.db 的文件夹）。
如果连接的是 DBX Web 或 Docker 部署，请让 MCP Server 指向 Web 后端 API。如果 Web 登录页需要密码，DBX_WEB_PASSWORD 填写同一个 Web 登录密码：
{
"mcpServers": {
"dbx": {
"command": "npx",
"args": ["-y", "@dbx-app/mcp-server"],
"env": {
"DBX_WEB_URL": "http://localhost:4224",
"DBX_WEB_PASSWORD": "你的 Web 登录密码"
}
}
}
}
支持 Claude Code、Cursor、Windsurf 等 MCP 兼容的 AI 助手。可列出连接、浏览表、执行 SQL，还能直接在 DBX 界面中打开表。
DBX 也提供独立 CLI 包，适合终端、脚本和 Codex 工作流：
npm install -g @dbx-app/cli
# 或通过 Homebrew
brew tap t8y2/dbx && brew install dbx-cli
dbx connections list --json
dbx query local "select 1" --json
详见 MCP Server 说明 和 CLI 说明。
安装
从 Releases 页面下载最新版本。
Homebrew (macOS)：
brew install --cask dbx
Scoop (Windows)：
scoop bucket add dbx https://github.com/t8y2/scoop-bucket
scoop install dbx
WinGet (Windows):
winget install t8y2.dbx
Flatpak (Linux)：
flatpak remote-add --if-not-exists flatpark https://dl.flatpark.org/flatpark.flatpakrepo
flatpak install flatpark com.dbxio.dbx
之后通过常规的 flatpak update 即可获取更新。详见 FlatPark 上的 DBX 页面。
自托管 (Docker)
DBX 提供 Web 版本，可通过 Docker 部署。示例使用 latest 标签以拉取当前发布版本。
docker run -d --pull=always --name dbx -p 4224:4224 -v dbx-data:/app/data t8y2/dbx:latest
这里使用跨平台的 dbx-data 命名卷。中国大陆用户可选用 CNB 镜像
docker.cnb.cool/dbxio.com/dbx:latest，以获得更快的拉取速度。
使用 Docker Compose 时，deploy/docker-compose.yml 保留为源码构建配置。
如需部署已发布的镜像，请使用 deploy/docker-compose.release.yml：
docker compose -f deploy/docker-compose.release.yml up -d
services:
dbx:
image: t8y2/dbx:latest
# 中国大陆用户可改用 CNB 镜像，以加快拉取速度：
# image: docker.cnb.cool/dbxio.com/dbx:latest
pull_policy: always
ports:
- "4224:4224"
volumes:
- dbx-data:/app/data
restart: unless-stopped
volumes:
dbx-data:
如需通过 nginx 等反向代理发布到 /dbx 这类子路径下，设置运行时上下文路径，并将同一前缀代理到容器：
environment:
- DBX_PUBLIC_BASE_PATH=/dbx
如果自行从源码构建前端并希望使用绝对资源路径，可在 pnpm build 前设置 VITE_DBX_BASE_PATH=/dbx/。
浏览器访问 http://localhost:4224。支持 amd64 / arm64 双架构镜像。
快速开始
环境要求
系统依赖
macOS：
无需额外安装。
Linux (Ubuntu/Debian)：
sudo apt-get install -y libwebkit2gtk-4.1-dev libgtk-3-dev libappindicator3-dev librsvg2-dev patchelf libssl-dev
NIXOS/NIX :
Windows：
无需额外安装。
开发
make
make 会在需要时安装根目录依赖，并启动本地 Tauri 桌面端开发环境。
Tip
DuckDB 从源码编译较慢。如果不涉及 DuckDB 功能，可以跳过以加速本地构建：
# 快速检查（跳过 DuckDB） make cargo-check-fast make cargo-test-fast # Tauri 开发模式跳过 DuckDB make dev-fast
--no-default-features仅影响本地开发，发布构建（pnpm tauri build）始终包含 DuckDB。
Web 版本：
make dev-web # 前端
make dev-backend # 后端
文档站：
make docs
DBX 官网文档位于 docs/ 目录。如果你想贡献官网内容或文档页面，请修改 docs/ 下的文件，并运行 make docs 在本地预览文档站。
JDBC Agent 驱动开发工程位于 agents/ 目录：
cd agents
./gradlew test
本地驱动安装流程会优先查找 agents/drivers/<db-type>/build/libs/ 下的构建产物。
构建
make package
安装包输出在 src-tauri/target/release/bundle/ 目录。
技术栈
| 层级 | 技术 |
|---|---|
| 框架 | Tauri 2 |
| 前端 | Vue 3 + TypeScript |
| UI | shadcn-vue + Tailwind CSS |
| 编辑器 | CodeMirror 6 |
| 后端 | Rust + sqlx / tiberius / redis-rs / mongodb |
文档
- 官方文档 — 功能说明与使用教程
- 贡献指南 — 如何认领 Issue 并提交 PR
- Web API 参考 — Docker/Web 部署的 HTTP API
- 示例代码 — CLI、MCP、Docker 与 API 示例
社区
