Skip to content
文档
Chat2DB CLI
数据源与 SQL

数据源与 SQL

Chat2DB CLI 可以通过本机 CLI runtime 读取数据源、测试连接、创建或维护数据源，并执行 SQL 查询。默认使用 --edition pro，操作 Local 时请显式加 --edition local。

开始前建议确认状态：

chat2db version --json
chat2db status --json

列出数据源

chat2db db datasources --edition pro --json

查看单个数据源：

chat2db db datasource --data-source-id <data-source-id> --json

这些命令是只读操作，不会修改数据源。

测试连接

测试已保存的数据源：

chat2db db connection-test --data-source-id <data-source-id> --json

使用主机字段测试 MySQL：

chat2db db connection-test \
  --db-type MYSQL \
  --host localhost \
  --port 3306 \
  --database test \
  --user root \
  --password '<password>' \
  --json

使用 JDBC URL 测试：

chat2db db connection-test \
  --db-type MYSQL \
  --url 'jdbc:mysql://127.0.0.1:3306/test' \
  --user root \
  --password '<password>' \
  --json

不要在文档、截图或聊天记录里暴露真实密码。带凭据的 JDBC URL 也应当脱敏。

创建数据源

创建数据源会写入 Chat2DB 保存的数据源列表。建议先运行 connection-test，确认连接成功后再创建。

使用 JDBC URL 创建：

chat2db db datasource-create \
  --db-type MYSQL \
  --url 'jdbc:mysql://127.0.0.1:3306/test' \
  --user root \
  --password '<password>' \
  --environment-id 1 \
  --json

使用主机字段创建：

chat2db db datasource-create \
  --db-type MYSQL \
  --host localhost \
  --port 3306 \
  --database test \
  --user root \
  --password '<password>' \
  --environment-id 1 \
  --json

environment-id 常用值：

值含义
1TEST
2RELEASE

更新和删除数据源

更新别名：

chat2db db datasource-update \
  --data-source-id <data-source-id> \
  --alias prod-mysql \
  --json

删除数据源：

chat2db db datasource-delete \
  --data-source-id <data-source-id> \
  --yes \
  --json

datasource-delete 需要 --yes。删除前请确认数据源 ID 和 edition，避免误删 Pro / Local 中的其他数据源。

读取数据库元数据

列出数据库：

chat2db db databases --data-source-id <data-source-id> --json

列出 schema：

chat2db db schemas \
  --data-source-id <data-source-id> \
  --database postgres \
  --json

列出表：

chat2db db tables \
  --data-source-id <data-source-id> \
  --database postgres \
  --schema public \
  --json

查看表结构：

chat2db db table \
  --data-source-id <data-source-id> \
  --database postgres \
  --schema public \
  --table users \
  --json

执行 SQL

查询第一页结果：

chat2db sql query \
  --data-source-id <data-source-id> \
  --database postgres \
  --schema public \
  --sql 'select 1' \
  --page-no 1 \
  --page-size 100 \
  --json

多结果集 SQL 可以用 --result-set-id 选择结果集：

chat2db sql query \
  --data-source-id <data-source-id> \
  --database postgres \
  --schema public \
  --sql 'select 1; select 2' \
  --result-set-id 2 \
  --no-row-number \
  --json

CLI 不会判断你的 SQL 是否会修改业务数据。对生产库执行 insert、update、delete、truncate、drop 等语句前，请先确认连接环境、数据库名和账号权限。

常见问题

Runtime 不可用

先检查 runtime：

chat2db runtime status --edition pro --json

必要时启动：

chat2db runtime start --edition pro --json

连接失败

优先用 connection-test 验证 host、port、database、user、password 或 JDBC URL。连接失败通常来自网络不可达、数据库账号权限不足、驱动或 JDBC URL 不匹配。

查不到数据源

确认 edition 是否正确：

chat2db db datasources --edition pro --json
chat2db db datasources --edition local --json
安装与状态检查MCP 与 Agent 集成