# DBX

> DBX is a free, open-source database client for MySQL, PostgreSQL, SQLite, Redis and 100+ data systems, with SQL editing, AI assistance and Docker self-hosting.

DBX is an Apache-2.0 database client, not a database server. The desktop app is approximately 25 MB; optional drivers, JRE packages, and plugins add downloads. Database capabilities vary by driver and engine.

The built-in AI assistant uses the provider you configure. MCP exposes selected DBX connections under access policies. Do not assume all features work with every database or that AI requests stay on the device.

## Official sources

- [English website](https://dbxio.com/en)

- [中文官网](https://dbxio.com/cn)

- [Source code and license](https://github.com/t8y2/dbx)

- [Release notes](https://dbxio.com/en/changelog): verify versions and downloads here rather than treating this file as live release metadata.

- [Supported databases](https://dbxio.com/en/databases)

- [Complete documentation text](https://dbxio.com/llms-full.txt): both languages, with source URLs for each document.

## English documentation

- [Deploy DBX with 1Panel](https://dbxio.com/en/markdown/1panel.md): Install, access, and update the DBX web edition from the 1Panel app store.

- [AI Assistant](https://dbxio.com/en/markdown/ai-assistant.md): Connect cloud, compatible API, or local CLI models to generate SQL, analyze data, and run controlled Agent workflows with schema context.

- [Changelog](https://dbxio.com/en/markdown/changelog.md): Track DBX release notes by version, mirrored from GitHub Releases.

- [DBX CLI](https://dbxio.com/en/markdown/cli.md): Use the native DBX CLI to read connections, schemas, query results, and AI context from terminals, scripts, CI, and Codex.

- [DBX Configuration Cloud Sync](https://dbxio.com/en/markdown/cloud-sync.md): Sync DBX connections, settings, and saved SQL with WebDAV, GitHub Gist, Gitee, or GitLab Snippets.

- [Config Export/Import](https://dbxio.com/en/markdown/config-export.md): Export database connections with AES-256-GCM encrypted passwords. Migrate securely between machines.

- [Connection Import](https://dbxio.com/en/markdown/connection-import.md): Import connections, groups, and recognized database profiles from Navicat, DBeaver, and DataGrip.

- [Build From Source and Contribute](https://dbxio.com/en/markdown/contributing.md): Set up DBX from scratch, run the desktop app, make your first change, test it, and open a pull request.

- [Data Grid](https://dbxio.com/en/markdown/data-grid.md): Browse, filter, edit, validate, copy, and export query results or table data in DBX.

- [Data Security Upgrade and Migration](https://dbxio.com/en/markdown/data-security-migration.md): A complete guide to upgrading existing DBX data to the encrypted Secret Store.

- [Data Transfer](https://dbxio.com/en/markdown/data-transfer.md): Copy tables between connections, databases, schemas, or database engines and track the result of each table.

- [Scheduled Database Backups](https://dbxio.com/en/markdown/database-backup.md): Create manual, hourly, daily, or weekly SQL backup schedules for MySQL and PostgreSQL in DBX Desktop.

- [Database Documentation](https://dbxio.com/en/markdown/database-docs.md): Browse a schema as documentation, annotate tables and columns with notes and colour-coded groups, and export DBML for dbdiagram.io or CI drift checks.

- [Database Export](https://dbxio.com/en/markdown/database-export.md): Stream structure, data, and readable database objects from one or more databases into SQL files.

- [Database Test Lab](https://dbxio.com/en/markdown/database-lab.md): Start reproducible, local database instances for DBX development and verification.

- [Database Support](https://dbxio.com/en/markdown/databases.md): Understand DBX connection profiles, driver runtimes, specialized workspaces, and capability-gated advanced features.

- [Driver Management](https://dbxio.com/en/markdown/driver-management.md): Manage built-in, native Agent, and JDBC Agent drivers, configure JRE versions, and handle driver updates.

- [FAQ](https://dbxio.com/en/markdown/faq.md): Frequently asked questions about DBX, including where connection data is stored and how to customize the data directory.

- [Field Lineage](https://dbxio.com/en/markdown/field-lineage.md): Analyze upstream, downstream, and potential column impact from foreign keys, view definitions, query history, and matching names.

- [Getting Started](https://dbxio.com/en/markdown/getting-started.md): Install DBX, create your first connection, and understand the desktop, Docker, and source workflows.

- [Keyboard Shortcuts](https://dbxio.com/en/markdown/keyboard-shortcuts.md): Review current defaults and customize editor, grid, sidebar, and global actions in Settings.

- [MCP Integration](https://dbxio.com/en/markdown/mcp.md): Let AI coding agents read metadata, query data, and use stateful sessions within DBX-managed Model Context Protocol policy.

- [MongoDB Workspace](https://dbxio.com/en/markdown/mongodb.md): Browse, filter, edit, and copy MongoDB documents and manage collections, indexes, and GridFS.

- [Object Browser](https://dbxio.com/en/markdown/object-browser.md): Use list or grid views to inspect database objects, statistics, source, and bulk actions.

- [Develop and Submit DBX Plugins](https://dbxio.com/en/markdown/plugin-development.md): Build DBX plugins with the CLI, Manifest, Workbench and Sidecar APIs, then debug, package, automatically submit, and publish them through the official Marketplace.

- [JDBC Plugin](https://dbxio.com/en/markdown/plugins.md): Install the DBX JDBC plugin, import vendor JDBC driver JARs, and create JDBC connections.

- [Production and Write Safety](https://dbxio.com/en/markdown/production-safety.md): Reduce database mistakes with read-only connections, production protection, SQL review, AI limits, and MCP policies.

- [Query Editor](https://dbxio.com/en/markdown/query-editor.md): Write, understand, parameterize, execute, analyze, and reuse SQL in DBX.

- [Redis Workspace](https://dbxio.com/en/markdown/redis.md): Browse, search, and edit Redis keys and inspect TTLs, Stream consumer groups, Pub/Sub, Slowlog, and instance status.

- [Schema Browser and Object Tree](https://dbxio.com/en/markdown/schema-browser.md): Organize connections, search database objects, open data and structure, and run database-specific actions from the DBX sidebar.

- [Schema and Data Comparison](https://dbxio.com/en/markdown/schema-diff.md): Compare schemas or table data, review differences, type mappings, impact, and synchronization SQL, then deploy to a target environment.

- [Specialized Workspaces](https://dbxio.com/en/markdown/specialized-workspaces.md): Manage Redis, MongoDB, Apache CouchDB, search and vector databases, HBase, message queues, etcd, ZooKeeper, Nacos, and Consul KV in DBX.

- [SQL File Execution](https://dbxio.com/en/markdown/sql-file.md): Preview and execute one or more SQL files in order with per-file statistics, statement progress, and failure reporting.

- [SQL Formatting](https://dbxio.com/en/markdown/sql-formatter.md): Format a selection or the full editor with database-aware syntax, then manage the current formatter options and JSON config.

- [SQL Quick Actions](https://dbxio.com/en/markdown/sql-quick-actions.md): Run built-in or custom SQL templates from the editor after selecting a table name.

- [SQL Snippets](https://dbxio.com/en/markdown/sql-snippets.md): Manage reusable SQL templates, trigger prefixes, and tab-stop placeholders for editor completion.

- [Tunnel / Proxy](https://dbxio.com/en/markdown/ssh-tunnel.md): Connect to private databases through SSH tunnels, HTTP tunnels, SOCKS5 proxies, or HTTP proxies.

- [Table Import](https://dbxio.com/en/markdown/table-import.md): Use a guided workflow to import CSV, TSV, text, JSON, Excel, SQL, or DuckDB Parquet data into an existing table or create new tables in batches.

- [Table Structure Editor](https://dbxio.com/en/markdown/table-structure.md): Inspect and edit columns, indexes, foreign keys, and triggers and review dialect-specific DDL before execution.

- [Web API Reference](https://dbxio.com/en/markdown/web-api.md): Internal HTTP APIs used by the DBX Web and Docker UI, including authentication, queries, background jobs, uploads, and downloads.

- [What is DBX?](https://dbxio.com/en/markdown/what-is-dbx.md): DBX is an open-source, lightweight workspace for 100+ databases and data systems, with desktop and self-hosted access, AI, CLI, and MCP.

## 中文文档

- [通过 1Panel 部署 DBX](https://dbxio.com/cn/markdown/1panel.md): 使用 1Panel 应用商店安装、访问和更新 DBX Web 版。

- [AI 助手](https://dbxio.com/cn/markdown/ai-assistant.md): 配置云端、兼容 API 或本地 CLI 模型，在 Schema 上下文中生成 SQL、分析数据并执行受控 Agent 工作流。

- [更新日志](https://dbxio.com/cn/markdown/changelog.md): 按版本查看 DBX 的新增功能、体验改进和问题修复，内容同步自 GitHub Releases。

- [DBX CLI](https://dbxio.com/cn/markdown/cli.md): 使用原生 DBX CLI 在终端、脚本、CI 和 Codex 中读取连接、Schema、查询结果和 AI 上下文。

- [DBX 配置云同步](https://dbxio.com/cn/markdown/cloud-sync.md): 使用 WebDAV、GitHub Gist、Gitee 或 GitLab Snippets 同步 DBX 连接、设置和保存的 SQL。

- [配置导出/导入](https://dbxio.com/cn/markdown/config-export.md): 导出数据库连接配置（AES-256-GCM 加密），安全地在不同电脑之间迁移。

- [连接导入](https://dbxio.com/cn/markdown/connection-import.md): 从 Navicat、DBeaver 和 DataGrip 导入连接、分组和可识别的数据库类型。

- [从源码编译与参与贡献](https://dbxio.com/cn/markdown/contributing.md): 从零搭建 DBX 开发环境，运行桌面版，完成第一次修改、测试并提交 Pull Request。

- [数据表格](https://dbxio.com/cn/markdown/data-grid.md): 在 DBX 中浏览、筛选、编辑、校验、复制和导出查询结果或表数据。

- [数据安全升级与迁移](https://dbxio.com/cn/markdown/data-security-migration.md): 将已有 DBX 数据升级到加密 Secret Store 的完整指南。

- [数据传输](https://dbxio.com/cn/markdown/data-transfer.md): 在不同连接、数据库、Schema 或数据库引擎之间批量复制表数据，并跟踪每张表的结果。

- [定时数据库备份](https://dbxio.com/cn/markdown/database-backup.md): 在 DBX 桌面端为 MySQL 和 PostgreSQL 创建可手动运行或按小时、每天、每周执行的 SQL 备份计划。

- [数据库文档](https://dbxio.com/cn/markdown/database-docs.md): 以文档方式浏览 Schema，为表和字段编写笔记并按颜色分组，导出 DBML 用于 dbdiagram.io 或 CI 中的结构漂移检查。

- [数据库导出](https://dbxio.com/cn/markdown/database-export.md): 将一个或多个数据库的结构、数据和可读取对象流式导出为 SQL 文件。

- [数据库测试实验室](https://dbxio.com/cn/markdown/database-lab.md): 为 DBX 开发与验证启动可重复创建的本地数据库实例。

- [数据库支持](https://dbxio.com/cn/markdown/databases.md): 了解 DBX 的连接 profile、驱动运行时、专用工作区和按能力启用的高级功能。

- [驱动管理](https://dbxio.com/cn/markdown/driver-management.md): 管理内置驱动、原生 Agent 和 JDBC Agent，配置 JRE 版本并处理驱动更新。

- [常见问题](https://dbxio.com/cn/markdown/faq.md): DBX 常见问题：连接数据保存在哪里、如何备份、如何让数据与程序同目录或自定义数据目录。

- [字段血缘](https://dbxio.com/cn/markdown/field-lineage.md): 从外键、视图定义、查询历史和同名字段中分析字段的上游、下游与潜在影响范围。

- [快速开始](https://dbxio.com/cn/markdown/getting-started.md): 安装 DBX、创建第一个连接，并了解桌面版、Docker 版和源码运行方式。

- [快捷键](https://dbxio.com/cn/markdown/keyboard-shortcuts.md): 查看当前默认按键，并在设置中为编辑器、表格、侧边栏和全局操作自定义快捷键。

- [MCP 集成](https://dbxio.com/cn/markdown/mcp.md): 通过 Model Context Protocol 让 AI 编程助手在 DBX 权限策略内读取元数据、查询数据和使用有状态会话。

- [MongoDB 工作台](https://dbxio.com/cn/markdown/mongodb.md): 浏览、筛选、编辑和复制 MongoDB 文档，并管理集合、索引和 GridFS。

- [对象浏览器](https://dbxio.com/cn/markdown/object-browser.md): 使用列表或网格集中查看数据库对象、统计信息、源码和批量操作。

- [开发和提交 DBX 插件](https://dbxio.com/cn/markdown/plugin-development.md): 从 CLI、Manifest、Workbench 和 Sidecar 开始开发 DBX 插件，完成本地调试、打包、自动上架和官方签名发布。

- [JDBC 插件](https://dbxio.com/cn/markdown/plugins.md): 安装 DBX JDBC 插件、导入数据库厂商驱动 JAR，并创建 JDBC 连接。

- [生产环境与写入安全](https://dbxio.com/cn/markdown/production-safety.md): 使用只读连接、生产环境保护、SQL 审查、AI 限制和 MCP 策略降低数据库误操作风险。

- [查询编辑器](https://dbxio.com/cn/markdown/query-editor.md): 使用 DBX 编写、理解、参数化、执行、分析和复用 SQL。

- [Redis 工作台](https://dbxio.com/cn/markdown/redis.md): 浏览、搜索和编辑 Redis Key，管理 TTL、Stream 消费组、Pub/Sub、Slowlog 和实例状态。

- [结构浏览与对象树](https://dbxio.com/cn/markdown/schema-browser.md): 使用 DBX 侧边栏组织连接、搜索数据库对象、打开数据与结构，并执行数据库专属操作。

- [Schema 与数据对比](https://dbxio.com/cn/markdown/schema-diff.md): 对比数据库结构或表数据，审查差异、类型映射、影响范围和同步 SQL，再部署到目标环境。

- [专项工作台](https://dbxio.com/cn/markdown/specialized-workspaces.md): 使用 DBX 管理 Redis、MongoDB、Apache CouchDB、搜索与向量数据库、HBase、消息队列、etcd、ZooKeeper、Nacos 和 Consul KV。

- [SQL 文件执行](https://dbxio.com/cn/markdown/sql-file.md): 预览并按顺序执行一个或多个 SQL 文件，查看逐文件统计、语句进度和失败结果。

- [SQL 格式化](https://dbxio.com/cn/markdown/sql-formatter.md): 使用数据库方言格式化所选 SQL 或整个编辑器，并管理当前版本的格式化选项和 JSON 配置。

- [SQL 快捷操作](https://dbxio.com/cn/markdown/sql-quick-actions.md): 在查询编辑器中选中表名后，通过快捷键执行内置模板或自定义 SQL。

- [SQL 代码片段](https://dbxio.com/cn/markdown/sql-snippets.md): 管理可复用 SQL 模板、触发键和可跳转占位符，并在编辑器补全中快速展开。

- [隧道/代理](https://dbxio.com/cn/markdown/ssh-tunnel.md): 通过 SSH 隧道、HTTP 隧道、SOCKS5 代理或 HTTP 代理连接内网数据库。

- [表数据导入](https://dbxio.com/cn/markdown/table-import.md): 通过向导将 CSV、TSV、文本、JSON、Excel、SQL 或 DuckDB Parquet 数据导入现有表，或按文件批量创建新表。

- [表结构编辑器](https://dbxio.com/cn/markdown/table-structure.md): 可视化查看和修改字段、索引、外键与触发器，并在执行前审查数据库方言对应的 DDL。

- [Web API 参考](https://dbxio.com/cn/markdown/web-api.md): DBX Web 与 Docker UI 使用的内部 HTTP API，包括认证、查询、后台任务、上传和下载边界。

- [什么是 DBX？](https://dbxio.com/cn/markdown/what-is-dbx.md): DBX 是一个开源、轻量的数据库与数据基础设施工作台，覆盖 100+ 种连接、桌面与自托管访问、AI、CLI 和 MCP。