## ❤️ Sponsors
|
RainYun is a cloud service provider offering cloud servers, physical servers, game hosting, and developer-friendly infrastructure services.
Visit RainYun
|
|
TrustAsia provides cloud-based code signing service for DBX, enabling trusted software through automated CI/CD builds.
Visit TrustAsia
|
|
Jalapeño Cloud is an AI infrastructure and token compute platform, with an exclusive DBX entry offering free credits and top-up bonuses.
Visit Jalapeño Cloud
|
|
Special thanks to AICodeMirror for sponsoring this project! AICodeMirror provides a high-stability official relay service for Claude Code / Codex / Gemini CLI, with enterprise-grade concurrency, fast invoicing, and 7×24 dedicated support. Official-channel pricing for Claude Code / Codex / Gemini is as low as 38% / 2% / 9% of list price, with extra discounts on top-ups! AICodeMirror offers a special benefit for DBX users: register through this link to enjoy 20% off your first top-up, and enterprise customers up to 25% off.
Visit AICodeMirror
|
|
HuaLongAI is a model API relay built for heavy AI developers, offering 100% official-source Codex and Claude models with transparent token-level billing, enterprise contracts, and invoicing.
Visit HuaLongAI
|
|
UCloud is the first public cloud provider listed on China's STAR Market, with 28 global regions for cloud hosting, databases, and CDN; its AstraFlow platform offers one-click access to 200+ mainstream LLMs.
Visit UCloud
|
|
Atlas Cloud gives developers one unified API for 400+ AI models across chat, image, video, and audio.
Visit Atlas Cloud
|
|
Qiniu Cloud provides DBX with object storage, CDN, and other cloud infrastructure resources.
Visit Qiniu Cloud
|
## 🤝 Partners
🪶 25 MB, zero runtime bloat
No Java JRE. No Python venv. No bundled Chromium. DBX ships as a single small binary — download, install, connect. DBeaver needs Java; TablePlus is Freemium. DBX runs everywhere with nothing extra.
|
🤖 AI that lives in your editor
Highlight a table, describe what you want, get SQL back — no copy-paste between tools. Works with Claude, OpenAI, or local models via Ollama. Built-in safety checks review AI-generated SQL before it runs.
|
🔌 MCP: your databases, AI-ready
DBX speaks the Model Context Protocol. Claude Code, Cursor, Windsurf, and other AI coding agents can query your databases through connections you already set up. One config, everywhere.
|
🌐 Desktop + Docker + Web
Native app on macOS, Windows, and Linux. Self-host via Docker for team access. Web version for browser-only environments. Same feature set. Same connections.
|
## Features
### 90+ Databases, One Tool
MySQL, PostgreSQL, SQLite, Cloudflare D1, Redis, MongoDB, DuckDB, ClickHouse, SQL Server, Oracle, Elasticsearch, Easysearch, Meilisearch, Qdrant, Milvus, Weaviate, MariaDB, TiDB, OceanBase, openGauss, GaussDB, KWDB, KingbaseES, Vastbase, GoldenDB, Doris, SelectDB, StarRocks, Manticore Search, Redshift, DM, TDengine, XuguDB, CockroachDB, Access, HighGo, UXDB, Dolt, and more. Agent-based profiles extend DBX to H2, Snowflake, Trino, PrestoSQL, Hive, DB2, Informix, Neo4j, Cassandra, BigQuery, Cloud Spanner, Kylin, SunDB, JDBCX, and custom JDBC connections. New native and agent-driven drivers also cover Databricks, SAP HANA, Teradata, Vertica, Firebird, Exasol, YashanDB, GBase 8a/8s, Databend, RQLite, Turso, InfluxDB, QuestDB, IoTDB, etcd, ZooKeeper, Nacos, Consul KV, IRIS, and more. Message queue admin is also available for Pulsar, Kafka, and RocketMQ. All in a single ~25 MB app. No bundled Chromium.
### Query Editor
CodeMirror 6 with SQL syntax highlighting, metadata-aware autocomplete, `Cmd+Enter` execution, selected SQL execution, SQL formatting, diagnostics, and 9 editor themes. Persistent query history, saved SQL snippets, tab restore, and SQL file execution keep repeat work close at hand.
### AI SQL Assistant
Describe what you want in plain language — get SQL back. DBX can explain queries, optimize SQL, fix errors, and run AI-generated SQL through built-in safety checks. Works with Claude, OpenAI, local models, or any OpenAI-compatible endpoint.
### Data Grid
Virtual-scrolled table that handles large result sets. Inline editing, SQL preview before save, WHERE / ORDER BY controls, DataGrip-style filters, LIKE / NOT LIKE context filters, sorting, full-text search, pagination, column resize, auto-fit, row numbers, zebra stripes, and full cell details. Export or copy as CSV, JSON, Markdown, XLSX, or INSERT statements.
### Schema Tools
- **Schema browser** — databases, schemas, tables, columns, indexes, foreign keys, triggers, with sidebar search & pin
- **Object browser** — grouped procedures, functions, views, and source editing where supported
- **Table structure editor** — reviewable column and index changes for supported engines
- **ER diagram** — visualize table relationships
- **Schema diff** — compare structures across connections
- **Explain plan** — visual query execution plan
- **Field lineage** — column-level lineage analysis
- **Database search** — find objects across large schemas
### Data Operations
- **Table import** — CSV, Excel
- **Data transfer** — migrate between databases
- **Database export** — full database dump
- **Data compare** — compare table data and review synchronization output
- **SQL file execution** — run `.sql` files directly
- **File preview** — drag & drop Parquet, CSV, JSON to preview instantly (powered by DuckDB)
- **Connection import** — bring connection profiles from DBeaver or Navicat
### Specialized Browsers
- **Redis** — key pattern search, batch key operations, command runner, TTL editing, and all data types (String, Hash, List, Set, ZSet, Stream)
- **MongoDB** — document CRUD with pagination, Atlas & replica set URL connection
### Safety & Connectivity
SSH tunnel (key & password) · database and AI proxy settings · auto-reconnect on connection loss · confirmation dialogs for destructive operations · encrypted config export/import · color-coded connections · driver store and optional JDBC plugin
### Polished UI
Dark mode with native title bar sync · 9 editor themes · English, 简体中文 & Español · layout preferences · built-in auto-update
## AI Agent Integration (MCP)
DBX provides a separate [Rust-powered MCP server](packages/mcp-server/) that lets AI coding agents query databases using connections configured in DBX. The MCP server is distributed independently from the desktop application, so installing DBX does not automatically install the MCP executable.
```bash
npx @dbx-app/mcp-server
```
Add to your `.mcp.json`:
```json
{
"mcpServers": {
"dbx": { "command": "npx", "args": ["-y", "@dbx-app/mcp-server"] }
}
}
```
Manage the connection allowlist and the **Read only**, **Data read/write**, and **Full access** modes in **DBX Settings → MCP**. The machine-readable values remain `read_only`, `safe_write`, and `high_risk_write`; client configs do not need permission or connection-scope environment variables.
For upgrade compatibility, an existing `DBX_MCP_ALLOW_WRITES=0` (or `false`) remains a read-only restriction only until a central MCP policy is saved for the first time; it can never enable writes or override a saved policy.
Windows portable builds need `DBX_DATA_DIR` in the MCP config, pointing to the `data` directory next to `DBX.exe` (the folder that contains `dbx.db`).
For DBX Web or Docker deployments, point the MCP server at the Web backend API. If the Web login page requires a password, set `DBX_WEB_PASSWORD` to the same password used there:
```json
{
"mcpServers": {
"dbx": {
"command": "npx",
"args": ["-y", "@dbx-app/mcp-server"],
"env": {
"DBX_WEB_URL": "http://localhost:4224",
"DBX_WEB_PASSWORD": "your-web-login-password"
}
}
}
}
```
Works with Claude Code, Cursor, Windsurf, and any MCP-compatible agent. Supports listing connections, browsing tables, executing SQL, and opening tables directly in DBX's UI.
Precompiled native binaries are also published for macOS, Linux, and Windows in [package releases](https://github.com/t8y2/dbx/releases?q=packages-v). They run without Node.js and are suitable for offline or server environments. The npm installation uses the same Rust binary through a small Node.js launcher.
DBX also provides a dedicated CLI package for terminal, script, and Codex workflows:
```bash
npm install -g @dbx-app/cli
# or via Homebrew
brew tap t8y2/tap && brew install dbx-cli
dbx connections list --json
dbx query local "select 1" --json
```
See the [MCP server README](packages/mcp-server/README.md) and [CLI README](packages/cli/README.md) for details.
## Install
Download the latest release from the [Releases](https://github.com/t8y2/dbx/releases/latest) page.
**Homebrew (macOS):**
```bash
brew install --cask dbx
```
**Scoop (Windows):**
```bash
scoop bucket add dbx https://github.com/t8y2/scoop-bucket
scoop install dbx
```
**WinGet (Windows):**
```
winget install t8y2.dbx
```
**Flatpak (Linux):**
```bash
flatpak remote-add --if-not-exists flatpark https://dl.flatpark.org/flatpark.flatpakrepo
flatpak install flatpark com.dbxio.dbx
```
Updates then arrive through the regular `flatpak update`. See the [DBX page on FlatPark](https://flatpark.org/apps/com.dbxio.dbx/) for details.
## Self-Hosted (Docker)
For scheduled backups after closing the desktop app or browser, see
[Background Database Backups](docs/background-database-backups.md), including
Windows/macOS/Linux startup and persistent container backup volumes.
DBX provides a web version that can be deployed via Docker. The examples use
the `latest` tag to pull the current release.
```bash
# The default keeps the key in the persistent /app/data volume.
docker run -d --pull=always --name dbx -p 4224:4224 \
-v dbx-data:/app/data \
t8y2/dbx:latest
```
This uses the cross-platform `dbx-data` named volume. Users in China can use
the CNB image, `docker.cnb.cool/dbxio.com/dbx:latest`, for faster pulls.
For Docker Compose, `deploy/docker-compose.yml` remains the source-build
configuration. To deploy a published image, use
`deploy/docker-compose.release.yml`:
```bash
docker compose -f deploy/docker-compose.release.yml up -d
```
```yaml
services:
dbx:
image: t8y2/dbx:latest
# For faster pulls in China, use the CNB image instead:
# 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:
```
Open `http://localhost:4224` in your browser. Multi-arch images (amd64 / arm64) are available.
Connection, plugin, AI, and tunnel credentials are encrypted before they are
written to `dbx.db`. Desktop builds use the local platform credential store
(macOS Keychain, Windows Credential Manager, or Linux Secret Service).
Web/Docker and directly running `dbx-web` use the same managed data-directory
key by default: `${DBX_DATA_DIR}/.dbx/secret.key`. The key is created only when
migration starts or the first sensitive value is written, and must be backed up
together with `dbx.db`. Persisting `/app/data` is therefore sufficient for a
normal Docker deployment. This key protects the database contents, but cannot
protect the whole data volume if the volume itself is copied or exposed.
For production deployments, replace the managed key with a Docker/Kubernetes
Secret by setting `DBX_SECRET_KEY_FILE`, or provide `DBX_SECRET_KEY` through a
secret manager. Explicit keys take precedence and must never be rotated while
encrypted data is in use. Without a usable key, business APIs remain blocked
and the browser displays the data security upgrade screen.
When running the binary directly, set `DBX_DATA_DIR=/var/lib/dbx` to use
`/var/lib/dbx/.dbx/secret.key` with the same lifecycle and backup rules.
When upgrading from a release that stored credentials in plain text, Desktop
and Web display a **Data Security Upgrade** wizard before opening the main
application. Choose **Start upgrade** to create a restricted backup, migrate
legacy database/JSON credentials, and verify that encrypted values can be
read. Failures retain the original data and backup; fix the issue shown in
the wizard and choose **Retry**. The backup path is shown after success.
Once you have verified your connections, **Delete migration backups** asks
for confirmation and removes the migration backup directory and the legacy
JSON `.bak` files created by that migration. Unrelated backup files are kept.
Users with no legacy data proceed directly after the initial check.
Local CLI and standalone MCP can reuse the existing platform credential
store on the same device, or read an explicitly configured
`DBX_SECRET_KEY_FILE`/`DBX_SECRET_KEY`. They do not create keys during the
startup check or automatically migrate legacy data. A
`DATA_MIGRATION_REQUIRED` error means that you must first open the same data
directory in Desktop or Web and complete its upgrade wizard. For headless
hosts without a platform credential store, configure the persistent key.
Cross-device exports use a separate sync passphrase and never contain the
local storage key. A direct `dbx.db` copy is not a cross-platform sync method:
platform keys do not move with the database. Use encrypted export/import so
the target device stores credentials using its own local key.
For the complete design, migration state machine, implementation map,
troubleshooting, and test plan, see
[DBX Data Security Upgrade and Migration](docs/data-security-migration.md).
To publish DBX under a reverse-proxy context path such as `/dbx`, set the
runtime base path and proxy the same prefix to the container:
```yaml
environment:
- DBX_PUBLIC_BASE_PATH=/dbx
```
When building the frontend yourself with an absolute asset base, set
`VITE_DBX_BASE_PATH=/dbx/` before `pnpm build`.
## Getting Started
### Prerequisites
- [Node.js](https://nodejs.org/) >= 18
- [pnpm](https://pnpm.io/)
- [Rust](https://www.rust-lang.org/tools/install) >= 1.88
#### System Dependencies
**macOS:**
No additional dependencies required.
**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 :**
[](https://linux.do)
[](https://1panel.cn)
## Star History