archery-table-schema

Files (5)

• SKILL.md
• commands.md · reference/
• errors.md · reference/
• mcp.md · reference/
• output-formats.md · reference/

SKILL.md (first lines)

# Archery 表结构查看

## 何时使用

- 写 SQL 前确认列名、类型、是否可空
- 查看表索引、主键等 DESCRIBE 信息
- 比手写 `DESCRIBE table` 或 `SHOW COLUMNS` 更可靠（走 Archery 统一接口）

**不知道表名时：** 先用 `archery-instance` 的 `instance tables` 列出表名。

**不要使用本 Skill：**

- 列出表名 → `archery-instance`（`instance tables`）
- 查数据行 → `archery-query`
- 搜库/实例 → `archery-instance` / `archery-database-search`

## 推荐工作流

```bash
# 1. 列出表名（archery-instance，实例可省略）
archery instance tables --db devops_center --table

# 2. 查看表结构（本 skill，实例可省略）
archery instance table-schema --db devops_center --table users
```

## 命令速查

```bash
archery instance table-schema [<实例>] --db <库> --table <表> [--schema <schema>]
```

## 参数

| 参数 | 必填 | 说明 |
|------|------|------|
| `<实例>` | 否 | Archery 实例名（可省略，按 `--db` 从缓存解析） |
| `--db` | 是 | 数据库名 |
| `--table` | 是 | 表名 |

## 输出

stdout 输出完整 `QueryResponse` JSON，`data.column_list` + `data.rows` 即为 DESCRIBE 结果。

## 约束

1. 实时 API 调用，不读 instance catalog 缓存（实例解析仍依赖 catalog）
2. 省略 `<实例>` 时按 `--db` 从 catalog 解析；唯一匹配自动使用，多匹配需显式指定
3. PostgreSQL/Oracle 等多 schema 引擎需传 `--schema`
4. 表名、列名保持 Archery 返回的原始大小写

## 参考

- 完整参数表：[reference/commands.md](reference/commands.md)
- 输出格式：[reference/output-formats.md](reference/output-formats.md)
- MCP 工具：[reference/mcp.md](reference/mcp.md)
- 常见错误：[reference/errors.md](reference/errors.md)

From xqdgithub/archery-cli, MIT.

More from xqdgithub/archery-cli