# dbx **Repository Path**: yonja/dbx ## Basic Information - **Project Name**: dbx - **Description**: No description available - **Primary Language**: Unknown - **License**: Apache-2.0 - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-08-19 - **Last Updated**: 2026-08-19 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README
## 为什么选择 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 版本适配纯浏览器环境。同样的功能,同样的连接配置。 |
银河麒麟 V10、统信 UOS 等系统推荐选择 **APM(AmberPM)版本**,以减少发行版依赖差异导致的安装或启动问题。APM 在兼容环境中运行 DBX;如果为 Agent/JDBC 驱动选择宿主机 Java,需要在路径前添加 `/host`,例如将 `/usr/bin/java` 填写为 `/host/usr/bin/java`。
## 自托管 (Docker)
DBX 提供 Web 版本,可通过 Docker 部署。示例使用 `latest` 标签以拉取当前发布版本。
```bash
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`:
```bash
docker compose -f deploy/docker-compose.release.yml up -d
```
```yaml
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` 这类子路径下,设置运行时上下文路径,并将同一前缀代理到容器:
```yaml
environment:
- DBX_PUBLIC_BASE_PATH=/dbx
```
如果自行从源码构建前端并希望使用绝对资源路径,可在 `pnpm build` 前设置 `VITE_DBX_BASE_PATH=/dbx/`。
浏览器访问 `http://localhost:4224`。支持 amd64 / arm64 双架构镜像。
## 快速开始
### 环境要求
- [Node.js](https://nodejs.org/) >= 18
- [pnpm](https://pnpm.io/)
- [Rust](https://www.rust-lang.org/tools/install) >= 1.88
#### 系统依赖
**macOS:**
无需额外安装。
**Linux (Ubuntu/Debian):**
```bash
sudo apt-get install -y libwebkit2gtk-4.1-dev libgtk-3-dev libappindicator3-dev librsvg2-dev patchelf libssl-dev
```
**NIXOS/NIX :**
查看 README-NIX.md
**Windows:**
无需额外安装。
### 开发
```bash
make
```
`make` 会在需要时安装根目录依赖,并启动本地 Tauri 桌面端开发环境。
开发版可与已安装的 DBX 同时运行,并共享本地连接和历史数据。请避免在两个窗口中同时修改同一个连接或全局设置。
> [!TIP]
> DuckDB 从源码编译较慢。如果不涉及 DuckDB 功能,可以跳过以加速本地构建:
>
> ```bash
> # 快速检查(跳过 DuckDB)
> make cargo-check-fast
> make cargo-test-fast
>
> # Tauri 开发模式跳过 DuckDB
> make dev-fast
> ```
>
> `--no-default-features` 仅影响本地开发,发布构建(`pnpm tauri build`)始终包含 DuckDB。
Web 版本:
```bash
make dev-web # 前端
make dev-backend # 后端
```
文档站:
```bash
make docs
```
DBX 官网文档位于 `docs/` 目录。如果你想贡献官网内容或文档页面,请修改 `docs/` 下的文件,并运行 `make docs` 在本地预览文档站。
需要干净、可重复创建的本地数据库实例时,可使用 [`deploy/database/`](deploy/database/README.zh-CN.md) 下的带版本 Docker Compose 配方:
```bash
make db-list
make db-verify DB=mysql@8.4
```
JDBC Agent 驱动开发工程位于 `agents/` 目录:
```bash
cd agents
./gradlew test
```
本地驱动安装流程会优先查找 `agents/drivers/|
|
雨云是面向开发者和站长的云服务提供商,提供云服务器、物理服务器、游戏云和配套基础设施服务。 | 访问雨云 |
|
七牛云为 DBX 提供对象存储、CDN 等云基础设施资源支持。 | 访问七牛云 |
|
Easysearch 是一款企业级分布式搜索引擎,兼容 ES API、融合全文检索、向量检索、地理空间位置检索、实时分析与 AI 能力,为企业提供统一的数据检索与智能分析基础设施。 | 访问 Easysearch |
|
|
Atlas Cloud 为开发者提供统一的多模态 AI API,可通过一个接口访问聊天、图像、视频和音频等 400+ 模型。 | 访问 Atlas Cloud |