DBX

数据库支持

DBX 的新建连接窗口提供 100+ 数据库和服务 profile。Profile 决定默认端口、表单字段、图标和驱动入口,但“能建立连接”不等于“支持所有高级功能”。

当前版本的连接选择器和 crates/dbx-core/assets/database-drivers.manifest.json 是数据库类型与能力的权威来源。文档不维护容易过期的全量静态矩阵。

连接类型

SQL 和兼容协议

  • MySQL、PostgreSQL、SQLite、SQL Server、ClickHouse、Oracle、Redshift 等核心 SQL 数据库
  • MariaDB、TiDB、OceanBase、Doris、SelectDB、StarRocks、Manticore Search、GoldenDB、Dolt 等 MySQL 协议或语法兼容 profile
  • openGauss、GaussDB、KingbaseES、HighGo、Vastbase、CockroachDB 等 PostgreSQL 兼容 profile
  • DM、KWDB、YashanDB、GBase、Teradata、Vertica、Exasol、Firebird、SAP HANA 等厂商数据库
  • Snowflake、Trino、PrestoSQL、Hive、Spark、DB2、Informix、Databricks、BigQuery 等 Agent/JDBC 分析数据库
  • Google Cloud Spanner 等云托管关系型服务(Agent/JDBC,支持 GoogleSQL 与 PostgreSQL 两种方言)

兼容协议只说明连接和部分方言可以复用。数据库版本、系统表、DDL、权限和管理接口不同,DBX 会用独立 profile 或能力覆盖避免错误地启用功能。

文件、边缘和托管数据库

  • SQLite、DuckDB、Microsoft Access
  • Cloudflare D1、Turso、RQLite
  • H2 和通过 JDBC URL 访问的本地数据库

自托管的 libSQL 服务器(sqld)使用 Turso 配置。主机填写服务器地址,例如 http://127.0.0.1:8080;除非服务器校验 JWT(--auth-jwt-key-file),否则 Auth Token 留空。未开启 SSL 时,http:// 地址保持明文 HTTP;libsql:// 地址和只填主机名时使用 HTTPS。

Desktop 的文件路径属于本机。Docker/Web 的文件路径属于服务器容器或宿主机挂载目录;浏览器电脑上的路径不会自动映射到服务器。

专用数据模型和服务

  • Redis、MongoDB、Apache CouchDB
  • Elasticsearch、Easysearch、Meilisearch、Manticore Search
  • Qdrant、Milvus、Weaviate、ChromaDB
  • HBase
  • Pulsar、Kafka、RocketMQ、RabbitMQ
  • etcd、ZooKeeper、Nacos、Consul KV
  • InfluxDB、IoTDB、TDengine 和其它时序/IoT profile

这些连接使用键值、文档、搜索、向量、消息或配置中心工作区,不应套用关系型表格和 SQL 的全部概念。入口详见 专用工作区。

驱动运行时

运行方式说明典型边界
内置原生Rust 驱动编译进 DBX安装后可直接使用
原生 Agent / sidecarDBX 管理独立 Go/Rust/外部进程需要匹配平台文件;DuckDB、Oracle、KingbaseES、XuguDB、RabbitMQ 等路径可能使用独立运行时
JDBC AgentJava Agent 加厂商 JDBC 驱动需要 JRE、Agent 和可合法获取的厂商 JAR
JDBC 插件可选通用 JDBC 扩展未识别数据库按通用 JDBC 能力运行

驱动的安装、更新、离线包和运行时监控见 驱动管理;自定义 JDBC 见 JDBC 插件。

Oracle OCI(thick 驱动)

Oracle 连接默认走 thin 驱动;连接对话框的驱动模式里还可以选 OCI,它由独立的 oracle-oci Agent(基于 Oracle 调用接口构建的 Go agent)承担,连接由 Oracle 客户端库建立。OCI 驱动目前只提供 Windows x64 版本。

  • Instant Client 目录是全局设置:填写包含 oci.dll 的目录,所有 OCI 连接共用;该目录会被加到 Agent 进程的动态库搜索路径最前面。
  • NLS_LANG 在 Oracle Client 里是进程级的,所以分两层配置:一个全局默认值,加上可选的连接级覆盖。一旦某个连接覆盖了 NLS_LANG,它就会独占一个 Agent 进程,字符集不会在连接之间串。
  • TNS 别名与钱包 / sqlnet.ora:TNS_ADMIN 支持全局默认与连接级覆盖(OCI 模式的连接表单里填写目录,留空跟随全局),任何 OCI 连接都能使用 tnsnames.ora 别名、ADB 钱包与 sqlnet.ora 网络选项(压缩、加密),不必切换到 TNS 连接方式;TNS 连接方式下目录也会随连接串传给 Agent 进程。
  • OCI 只改变客户端库的加载方式;网格编辑、DDL、传输等功能与 thin 驱动一致。

能力等级

DBX 驱动清单使用从连接到操作的能力等级,并允许按数据库覆盖单项能力:

能力层含义
Connect建立连接并执行该 profile 支持的基础查询
Browse浏览数据库、Schema、表或专用对象
Understand增加对象源码、搜索、关系理解等只读能力
Operate增加表数据编辑等受控写入能力

具体功能还由独立 capability 控制,例如:

  • Schema 搜索和 ER 图
  • 表数据编辑和表结构编辑
  • 表导入和数据传输
  • SQL 文件执行
  • 字段血缘和执行计划
  • 创建数据库、用户管理和驱动管理

因此菜单是否出现比“数据库名称是否在支持列表中”更能反映当前路径。缺少入口时,应检查 DBX 版本、数据库 profile、驱动模式和已安装组件。

功能边界

SQL 文件和关系型工具

Redis、MongoDB、搜索、向量、HBase、配置中心和消息队列工作区不会使用关系型 SQL 文件执行。部分 SQL 数据库只支持查询和浏览,不支持结构编辑、表导入或数据传输。

导入和传输

表数据导入 与 数据传输 都按 capability 过滤连接。跨引擎路径还受类型映射、键、identity、Schema 和目标 DDL 能力限制。

备份和导出

  • 数据库导出 是能力驱动的逻辑 SQL 导出
  • 数据库备份 当前只在 Desktop 为 MySQL、PostgreSQL 和 openGauss 提供定时一致性备份
  • 云同步和配置导出只迁移 DBX 配置,不会备份业务数据库

原生 Job 与 Scheduler 作业

Oracle、OceanBase Oracle 连接的 原生作业 入口与达梦的 代理作业 共用管理页。在 作业类型 中切换 Scheduler 和传统 Job;达梦另有 SYSJOB 代理作业。所有者筛选与作业搜索由数据库查询执行,不局限于当前列表页。同名的 Scheduler 作业按所有者分别选择。

Scheduler 的新建和编辑表单包含定义、参数和高级属性。参数可区分保持原值、未设置、继承默认、SQL NULL 和显式值;不能安全转换的原生值保留原样。更改前先预览,再使用同页结果区核对执行状态。传统 Job 保留原生数字 ID,不从显示名称推断身份;LOG_USER、PRIV_USER 和 SCHEMA_USER 分别显示。新建传统 Job 的 SCHEMA_USER 设置执行 schema,不改变登录身份。

新建 Scheduler 作业时,可在适用数据库中从数据库对象列表选择 Program、命名 Schedule 或 Chain;高级属性中可选择 Credential 和 Destination。列表按所有者和名称筛选、分页,并显示实际可读范围。系统视图不可读时仍可填写精确名称。选用 Program 或命名 Schedule 后,对应内联字段会保留在草稿中但不写入;清除引用可恢复编辑内联字段。

引用 Program 时,参数数量和默认值从 Program 读取,不使用作业的内联参数数量推断。参数区域分别展示默认值和作业的显式值;数据库提供的元数据参数不可覆盖。无法确定的默认值不会当作 SQL NULL。新建表单及 Oracle 引用编辑会分别保留 Program 和内联参数草稿,不把旧参数自动写入新的 Program。

Oracle 的参数值可选择普通文本或明确的 ANYDATA 标量类型;SQL NULL 会保留所选类型,不等于未设置或继承。NUMBER 按完整十进制文本输入;日期与时间分开填写,时间戳最多保留 9 位小数,带本地时区的时间以 UTC 编辑。INTERVAL 使用总月数或总纳秒数,RAW 使用十六进制,BINARY_FLOAT/BINARY_DOUBLE 使用完整位模式。Program 默认值使用同样的只读控件展示;不能保真读取的值保持只读。Lightweight 作业不提供 ANYDATA 输入。

编辑已有 Oracle Scheduler 作业时,可在同一编辑器中更换 Program、Schedule、Window、Window group 或 Chain,并在高级属性中选择凭据和目的地。选择 Program 后,先核对目标参数,再选择最终启用状态。预览包含暂停未来调度及条件参数设置或重置;已满足目标的参数会跳过,出现外部冲突则停止。只有定义和参数全部验证通过后,才应用所选启用状态。

Oracle 的 触发方式 可选择日期或重复规则、命名调度或窗口、队列事件、文件到达事件。队列事件分别填写所有者、队列名称、可选 AQ 代理和事件条件;文件到达事件可复用 File watcher 选择器。未选中的时间或引用输入保留在草稿中,不写入当前目标。目的地组只作为引用选择,不展开或修改共享组;不兼容的作业类型会在预览时拒绝,保留输入供修正。

Oracle 高级属性中的 执行目标 可选择本地执行、传统远程主机(host[:port])或命名目的地及目标组。主机文本按原样编辑,不按对象名解析。切换模式会保留未选中模式的草稿,预览只包含当前选择;选择本地执行可清除原远程目标。

部分成功后先核对当前状态,再使用 修正草稿 重新读取和预览。恢复原定义草稿 将最初读到的定义放回编辑器,不直接回滚数据库;仍须核对当前状态并确认新的预览。编辑不会自动重跑作业。

异步运行或停止显示 已接受 时,只表示管理请求已被接受。同页的 原生执行观测 分别展示当前运行、历史读取状态和可识别的实例,可使用 刷新运行结果 再读。新观察到的成功、失败或停止记录不自动归因于本次请求;关联不确定时会明确说明。没有当前运行行不等于未执行,也不等于已由本次请求停止;DBX 不会据此自动重跑。

引用列表需要相应系统视图的读取权限。OceanBase V4.2.5 的 Program 视图为 SYS.DBA_SCHEDULER_PROGRAM,不同于 Oracle 的复数名称;普通账号没有该视图的读取权限时,列表可能返回 ORA-00942。列表不可读不等于引用对象不存在,DBX 不会自动授予权限。

OceanBase V4.2.5 的 Job 和 Program 参数视图 为兼容占位,即使存在实际参数也始终返回空。参数区域会说明无法读取,不将空结果解释为没有参数;仍可操作不依赖这些参数的可读定义和控制项。

OceanBase V4.2.5 的已有 Scheduler 作业基础定义只读;可在 高级属性 中修改作业类、最大失败次数、最大运行时长和执行 Zone。时长使用非负整秒的 DS interval,例如 0 00:02:00 表示两分钟;Zone 使用名称或 RANDOM,不是 Oracle 的数字实例。最大失败次数从身份核对后的原生视图读取,该字段不可读时不影响其他可编辑属性。字段不能清空时,表单不提供清空动作。

这与新建时的输入范围不同:新建仍可设置初始正文、日期、重复表达式和注释,参数数量为 0–255;类型为 STORED_PROCEDURE 或 PLSQL_BLOCK。本版不提供命名 Schedule、Credential 或 Destination 的创建输入,Program 引用按本版原生规则处理。

OceanBase 传统 Job 使用可为空的 Zone 名称,不使用 Oracle 的数字实例。新建需要配套的 OceanBase Agent 或 Generic JDBC 运行包;页面提示更新时,更新运行包后重新连接。数据库还需由管理员启用 DBMS_JOB 包,DBX 不会自动更改全局开关。新建会先设置所选启用状态和日期,再确认首次提交;启禁用保留执行时读取的最新下次运行日期。

Oracle 和 OceanBase 传统 Job 的 前台运行 会等待原生调用返回。在已验证的 OceanBase 4.2.5.7 中,运行还会清除禁用标记并重新计算下次运行日期;确认预览前应核对这一调度影响。传统 DBMS_JOB 没有原生停止入口,不能将停止会话当作停止作业。Oracle Scheduler 的普通停止与 强制停止 分开预览和确认;OceanBase 不套用 Oracle 的强制停止签名。

达梦 SYSJOB 作业

本期 DM 尚未实现以下操作:已有 Scheduler 作业内联定义与 Program/命名 Schedule 引用之间的建立或解除、参数 RESET/恢复继承、Job 执行 schema 迁移,以及传统 DBMS_JOB 新建。DBX 不会发送未经确认的原生调用;不能将上文 Oracle 的引用编辑和传统 Job 新建能力套用于 DM。这些能力待精确原生契约确认后补齐。原生 Oracle、DM8 实机验收另行暂缓;自动化和模拟边界界面检查不代表实库验证通过。

从达梦连接的 代理作业 入口管理 SYSJOB 作业。列表可按名称、所有者或描述搜索;选中作业后分别读取属性、步骤、调度、当前运行和历史。某部分无权限或读取失败时会单独显示,不按空数据处理。

新建作业时:

  1. 点击 新建作业,填写名称,在 作业属性 中选择最终启用状态。
  2. 在 步骤 中填写 SQL 或原生配置参数;可新增多个步骤并设置成功、失败后的动作和下一步骤。在 调度 中配置一个或多个时间安排。
  3. 点击 预览 SQL,核对目标和配置,再确认执行。DBX 会先禁用创建,在同一物理会话完成配置、读回确认后,才按选择最终启用。

已有作业使用 编辑作业 修改,未改属性和子项保持不变。备份、还原或 DTS 步骤显示的 COMMAND 可能是数据库生成的语句;修改其定义时应提供原始配置参数,不把生成语句重新当作配置输入。

部分成功或结果未知时,在原结果区使用 重新读取、修正草稿 和 查询操作结果。已确认创建的作业和子项按原生 ID 继续处理;响应不明的新增不会自动按同名认领或重复创建。修正并确认新的预览后,只执行剩余变更,不自动重跑业务作业。

停止后续步骤 只取消尚未发送的管理操作。需要停止正在运行的作业时,使用 停止当前执行;停用未来调度不等于停止当前运行。作业环境不存在时,页面提供单独的 初始化作业环境,不会自动初始化。

Desktop 和 Docker/Web

两种运行方式共享大部分 Rust 核心查询、元数据和安全策略,但并非功能完全相同。Desktop 才有本地 SQL 文件目录、系统文件选择、Deep Link、本机 CLI Agent 和定时数据库备份;Web 文件、驱动和 Agent 都位于服务器数据目录。

默认端口和连接 URL

连接 profile 会填入常见默认端口,例如 MySQL 3306、PostgreSQL 5432、Redis 6379、MongoDB 27017、SQL Server 1433、Oracle 1521、Elasticsearch 9200、CouchDB 5984、Meilisearch 7700、RabbitMQ AMQP 5672。这些只是默认值,可以按部署修改。

RabbitMQ 等服务可能同时有业务端口和管理 API 端口;自定义 AMQP 端口不能用于推断 Management API 端口。SSH 隧道、HTTP 代理、TLS SNI 和实际拨号目标也应分别确认。

DBX 可以解析许多常见 DSN/URL,但不同数据库版本和云厂商参数差异很大。连接测试成功后仍应检查实际数据库、Schema、SSL 和权限范围。

Elasticsearch API Key 认证

Elasticsearch API Key authentication

在连接表单中选择 认证 → API Key,把编码后的 Elasticsearch API Key(Base64(id:api_key))粘贴到隐藏显示的 API Key 输入框。只填编码值,不要加 ApiKey 前缀;DBX 会为每次请求添加 Authorization: ApiKey … 请求头。此模式不使用用户名,直连和 Kibana 代理连接均使用所选认证方式。

API Key 复用现有的加密密码存储,并遵循 保存密码 设置(取消勾选则仅在当前会话使用)。已有连接继续使用 Basic 用户名/密码认证;切换认证方式会清空凭据输入框,以便输入新凭据。

CLI/MCP 配置中,将 external_config.authType 设为 "apiKey",编码后的 Key 填入 password;不要把密钥放入 URL 参数或 external_config。

本地测试环境

仓库提供 ClickHouse、MariaDB、MongoDB、MySQL、PostgreSQL 和 Redis 的固定 Docker Compose 测试环境,适合验证连接、驱动行为和回归。详见 数据库测试实验室。

相关页面