# xsql - AI 优先的跨数据库 CLI 工具 xsql 是一个命令行工具，专为 AI 代理设计，用于在 MySQL 和 PostgreSQL 数据库上执行只读 SQL 查询，并具有可选的 SSH 隧道支持。 ## 安装去安装 github.com/zx06/xsql/cmd/xsql@latest ## 先决条件 * 确保存在有效的 `xsql.yaml`（`./xsql.yaml` 或 `~/.config/xsql/xsql.yaml`）或传递 `--config`。 * 在运行查询之前确认目标配置文件存在。 ## 快速参考 # 查询个人资料 xsql 查询“SELECT * FROM users LIMIT 10” -p -f json # 列出所有配置文件 xsql配置文件列表-f json # 显示个人资料详细信息 xsql 配置文件显示 <配置文件> -f json # 获取工具规格 xsql 规范 --format json # 检查版本 xsql版本 ## 常见查询工作流程 ### 0\.识别目标数据库 # 列出配置文件 xsql配置文件列表-f json # 检查配置文件以确认数据库/主机 xsql 配置文件显示 <配置文件> -f json ### 1\.探索架构 SQL 语法因数据库而异（MySQL 与 PostgreSQL）。根据需要调整语句。 # 列出表 xsql 查询“显示表”-p <配置文件> -f json # 描述一个表 xsql 查询“描述表名”-p <配置文件> -f json ### 2\.了解数据分布 # 计算行数 xsql 查询“SELECT COUNT(*) AS Total FROM table_name”-p -f json # 示例行 xsql 查询 "SELECT * FROM table_name LIMIT 10" -p -f json ### 3\.调查有问题的记录 # 时间窗口 xsql 查询“SELECT * FROM table_name WHERE create_at >= NOW() - INTERVAL 7 DAY”-p -f json # 关键字段过滤器 xsql 查询“SELECT * FROM table_name WHERE status = 'failed' LIMIT 50” -p -f json ## 命令命令 |目的 ---|--- `xsql 查询 ` |运行查询（默认情况下只读） `xsql 配置文件列表` |列出个人资料 `xsql 配置文件显示` |显示个人资料详细信息 `xsql 规范` |导出工具规格 `xsql 版本` |版本信息 `xsql mcp 服务器` | MCP集成 ### 查询标志 * `-p, --profile`: 选择配置文件 * `-f, --format`: `json|yaml|table|csv|auto` * `--unsafe-allow-write`：允许写入（危险，默认禁用） * `--allow-plaintext`：允许明文密码（仅当在配置中明确启用时） * `--ssh-skip-known-hosts-check`: 跳过known_hosts检查（有风险） ## 输出和错误 * 非TTY默认为JSON，TTY默认为表 * 使用 `-f json` 强制输出 JSON * 标准输出是数据； stderr 是日志 * 成功: `{"ok":true,...}`;失败：`{“ok”：false，“error”：{...}}` * 退出代码稳定；使用“error.code”进行编程处理 ## 配置和环境 * 优先级：CLI > ENV > 配置 * 路径： `--config` > `./xsql.yaml` > `~/.config/xsql/xsql.yaml` * 尽可能将秘密存储在密钥环中；仅在明确启用时才允许纯文本 ## 最佳实践 * 使用 `-f json` 进行机器消耗 * 使用`ok`和`error.code`来判断是否成功 * 默认只读；写入需要 `--unsafe-allow-write`

数据库

包含技能