feat: show username/password fields for Access database connections

This commit is contained in:
t8y2 committed 2026-06-10 08:37:18 +08:00
1 parent 2e021d37d1
commit edba8214b5
477 files changed
+5720 -19773

No files matched your search

+24 -28
View File
@@ -3,9 +3,7 @@ title: DBX CLI
description: Use DBX connections from terminals, scripts, CI, and Codex.
---
<Callout type="info">
DBX CLI is a dedicated command line package for terminal, script, and coding-agent workflows. It shares DBX connection storage and SQL safety rules with the MCP server.
</Callout>
<Callout type="info">DBX CLI is a dedicated command line package for terminal, script, and coding-agent workflows. It shares DBX connection storage and SQL safety rules with the MCP server.</Callout>
## Install
@@ -119,16 +117,16 @@ select 1"
CLI JSON errors use stable codes:
| Code | Meaning |
|---|---|
| `UNKNOWN_OPTION` | An unsupported flag was provided |
| `INVALID_OPTION` | A flag is missing a value or has an invalid value |
| `INVALID_ARGUMENT` | Positional arguments are missing or conflicting |
| Code | Meaning |
| ------------------------ | --------------------------------------------------- |
| `UNKNOWN_OPTION` | An unsupported flag was provided |
| `INVALID_OPTION` | A flag is missing a value or has an invalid value |
| `INVALID_ARGUMENT` | Positional arguments are missing or conflicting |
| `CONNECTION_STORE_ERROR` | DBX connection storage exists but could not be read |
| `CONNECTION_NOT_FOUND` | No DBX connection matched the requested name |
| `SQL_BLOCKED` | SQL safety rules blocked execution |
| `DBX_NOT_RUNNING` | DBX Desktop bridge is unavailable |
| `ERROR` | Unexpected runtime failure |
| `CONNECTION_NOT_FOUND` | No DBX connection matched the requested name |
| `SQL_BLOCKED` | SQL safety rules blocked execution |
| `DBX_NOT_RUNNING` | DBX Desktop bridge is unavailable |
| `ERROR` | Unexpected runtime failure |
## Desktop Deep Links
@@ -148,19 +146,19 @@ open 'dbx://connection/new?type=mysql&host=127.0.0.1&port=3306&user=root&passwor
Supported fields:
| Field | Meaning |
|---|---|
| `type` | Database type, such as `mysql`, `postgres`, `redis`, or `mongodb` |
| `url` | Database DSN; URL encoding is recommended |
| `name` | Display name in DBX; when omitted, DBX uses `database`, then `host` |
| `host` | Hostname or IP address |
| `port` | Port |
| `user` | Username |
| `password` | Password |
| `database` | Database name; for Redis this can be a DB index such as `0` |
| `url_params` | Extra connection parameters, such as `sslmode=require` |
| `ssl` | Enable SSL when set to `true` |
| `one_time` | Automatically connect when set to `true`, then delete the connection after disconnecting |
| Field | Meaning |
| ------------ | ---------------------------------------------------------------------------------------- |
| `type` | Database type, such as `mysql`, `postgres`, `redis`, or `mongodb` |
| `url` | Database DSN; URL encoding is recommended |
| `name` | Display name in DBX; when omitted, DBX uses `database`, then `host` |
| `host` | Hostname or IP address |
| `port` | Port |
| `user` | Username |
| `password` | Password |
| `database` | Database name; for Redis this can be a DB index such as `0` |
| `url_params` | Extra connection parameters, such as `sslmode=require` |
| `ssl` | Enable SSL when set to `true` |
| `one_time` | Automatically connect when set to `true`, then delete the connection after disconnecting |
One-time connection example:
@@ -168,9 +166,7 @@ One-time connection example:
open 'dbx://connection/new?type=redis&host=127.0.0.1&port=6379&user=default&password=secret&database=0&one_time=true'
```
<Callout type="info">
Before testing system-level `dbx://` launches, install and open DBX Desktop once so the operating system can register the URL scheme. On macOS, use `open 'dbx://connection/new?...'` to test it.
</Callout>
<Callout type="info">Before testing system-level `dbx://` launches, install and open DBX Desktop once so the operating system can register the URL scheme. On macOS, use `open 'dbx://connection/new?...'` to test it.</Callout>
## Codex