20MB lightweight database client for 70+ databases
Go to file
t8y2 3eff55e4e2 fix: sync web connection config cache 2026-05-10 22:38:47 +08:00
.cargo perf: use lld linker for faster Windows builds 2026-05-07 16:21:21 +08:00
.claude/commands chore: bump version to 0.4.3 2026-05-07 11:51:59 +08:00
.github test: 接入前端测试脚本 2026-05-10 22:32:01 +08:00
.husky chore: add src-web to pre-commit cargo fmt hook 2026-05-05 21:14:24 +08:00
1panel feat(ci): add 1Panel App Store auto-submission 2026-05-10 22:16:07 +08:00
crates/dbx-core refactor(ci): trigger Homebrew/Scoop publish on release event 2026-05-10 22:23:25 +08:00
docs docs(jdbc): add JDBC plugin usage guide 2026-05-10 13:08:32 +08:00
mcp fix(mcp): write complete config_json matching Rust ConnectionConfig schema 2026-05-09 12:04:46 +08:00
plugins/jdbc feat(jdbc): add optional JDBC plugin support 2026-05-10 12:57:38 +08:00
public Refactor code structure for improved readability and maintainability 2026-05-05 13:21:04 +08:00
src test: add backend API contract coverage 2026-05-10 22:34:37 +08:00
src-tauri feat(objects): show routines in object browser 2026-05-10 21:14:16 +08:00
src-web fix: sync web connection config cache 2026-05-10 22:38:47 +08:00
tests test: add backend API contract coverage 2026-05-10 22:34:37 +08:00
.dockerignore feat: add web deployment with axum server, Docker support, and browser UI 2026-05-05 03:16:50 +08:00
.gitignore feat(jdbc): add optional JDBC plugin support 2026-05-10 12:57:38 +08:00
.oxfmtrc.json chore: add oxfmt + husky + lint-staged for code formatting and CI format checks 2026-05-05 15:41:34 +08:00
Cargo.lock feat(external): add tabular source foundation 2026-05-10 20:52:03 +08:00
Cargo.toml fix: update workspace paths and optimize Rust caching in CI workflows 2026-05-05 21:45:17 +08:00
Dockerfile fix(docker): touch source files to force cargo recompilation 2026-05-07 21:12:41 +08:00
LICENSE docs: revamp README with new screenshots and AGPL-3.0 license 2026-05-06 01:40:54 +08:00
README.md docs: add system dependencies and update GaussDB driver info 2026-05-07 13:18:02 +08:00
README.zh-CN.md docs: add system dependencies and update GaussDB driver info 2026-05-07 13:18:02 +08:00
components.json feat: initial release 2026-04-29 18:09:23 +08:00
docker-compose.yml feat: add web deployment with axum server, Docker support, and browser UI 2026-05-05 03:16:50 +08:00
index.html feat: enhance loading experience and update window visibility settings 2026-04-29 18:33:41 +08:00
package.json test: 接入前端测试脚本 2026-05-10 22:32:01 +08:00
pnpm-lock.yaml test: 接入前端测试脚本 2026-05-10 22:32:01 +08:00
rustfmt.toml chore: add rustfmt.toml and apply unified code formatting 2026-05-05 14:16:18 +08:00
tsconfig.json feat: initial release 2026-04-29 18:09:23 +08:00
vite.config.ts feat: add web deployment with axum server, Docker support, and browser UI 2026-05-05 03:16:50 +08:00

README.md

DBX

25+ databases in 15 MB. Desktop & Docker self-hosting, with built-in AI assistant.

Join Discord Join QQ Group

English | 前往中文版本

Features

17+ Databases, One Tool

MySQL, PostgreSQL, SQLite, Redis, MongoDB, DuckDB, ClickHouse, SQL Server, Oracle, Elasticsearch, MariaDB, TiDB, OceanBase, openGauss, GaussDB, KingBase, Vastbase, GoldenDB — connect to all of them from a single ~15 MB app. No bundled Chromium.

Query Editor

CodeMirror 6 with SQL syntax highlighting, smart autocomplete (tables & columns), Cmd+Enter execution, selected SQL execution, SQL formatting, and 9 editor themes. Persistent query history with search and restore.

AI SQL Assistant

Describe what you want in plain language — get SQL back. Also explains, optimizes, and fixes errors. Works with Claude, OpenAI, or any OpenAI-compatible endpoint.

Data Grid

Virtual-scrolled table that handles millions of rows. Inline editing, sorting, full-text search, pagination, column resize, row numbers, zebra stripes. Export to CSV, JSON, Markdown.

Schema Tools

  • Schema browser — databases, schemas, tables, columns, indexes, foreign keys, triggers, with sidebar search & pin
  • ER diagram — visualize table relationships
  • Schema diff — compare structures across connections
  • Explain plan — visual query execution plan
  • Field lineage — column-level lineage analysis

Data Operations

  • Table import — CSV, Excel
  • Data transfer — migrate between databases
  • Database export — full database dump
  • SQL file execution — run .sql files directly
  • File preview — drag & drop Parquet, CSV, JSON to preview instantly (powered by DuckDB)

Specialized Browsers

  • Redis — key pattern search, 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) · auto-reconnect on connection loss · confirmation dialogs for destructive operations · encrypted config export/import · color-coded connections

Polished UI

Dark mode with native title bar sync · 9 editor themes · English & 简体中文 · built-in auto-update

AI Agent Integration (MCP)

DBX provides an MCP server that lets AI coding agents query your databases using connections already configured in DBX.

npx @dbx-app/mcp-server

Add to your .mcp.json:

{
  "mcpServers": {
    "dbx": { "command": "npx", "args": ["-y", "@dbx-app/mcp-server"] }
  }
}

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.

See the MCP server README for details.

Install

Download the latest release from the Releases page.

Homebrew (macOS):

brew install --cask t8y2/tap/dbx

Scoop (Windows):

scoop bucket add dbx https://github.com/t8y2/scoop-bucket
scoop install dbx

Self-Hosted (Docker)

DBX provides a web version that can be deployed via Docker.

docker run -d --name dbx -p 4224:4224 -v dbx-data:/app/data t8y2/dbx

Or with Docker Compose:

services:
  dbx:
    image: t8y2/dbx
    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.

Getting Started

Prerequisites

System Dependencies

macOS:

brew install unixodbc

Linux (Ubuntu/Debian):

sudo apt-get install -y libwebkit2gtk-4.1-dev libgtk-3-dev libappindicator3-dev librsvg2-dev patchelf libssl-dev unixodbc-dev

Windows:

No additional dependencies required (ODBC is built into Windows).

Development

pnpm install
pnpm dev:tauri

Web version:

pnpm dev:web       # frontend
pnpm dev:backend   # backend

Build

pnpm tauri build

The installer will be in src-tauri/target/release/bundle/.

Tech Stack

Layer Technology
Framework Tauri 2
Frontend Vue 3 + TypeScript
UI shadcn-vue + Tailwind CSS
Editor CodeMirror 6
Backend Rust + sqlx / tiberius / redis-rs / mongodb

Community

Discord QQ Group LINUX DO

Contributors

Star History

Star History Chart

License

AGPL-3.0