Skip to content

docs: 清理已移除功能的残留描述 #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zavier merged 1 commit into from
Aug 1, 2026
Merged

docs: 清理已移除功能的残留描述 #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,12 +85,11 @@ formatting/ ← formatTableResult —— 自动布局：横向 / 转置 /
- **TUI**：`pi.appendEntry("db-query-result", data)` + `registerEntryRenderer` → 自适应宽度 Component（横向/转置/纵向，列宽打包用 `layoutColumns`）。`ctrl+o` 展开为完整纵向输出。
- **LLM 上下文**：`pi.sendMessage({ display: false, ... })` → `formatTableCompact`——无填充的 markdown，200 字符单元格上限加 `…[+N]` 标记，包含所有行。

| customType | 渲染器 |
| -------------------- | ----------------------------------------------------------------- |
| `db-query-result` | Entry 渲染器：表头 + SQL + 自适应表格；关联表提示；展开看完整行。 |
| `db-workspace-panel` | Message 渲染器：原始预格式化文本（面板不是 markdown）。 |
| customType | 渲染器 |
| ----------------- | ----------------------------------------------------------------- |
| `db-query-result` | Entry 渲染器：表头 + SQL + 自适应表格；关联表提示；展开看完整行。 |

其他（`db-tables`、`db-table-schema`、`db-er-diagram`）使用默认自定义消息渲染（紫色框 + markdown）——内容小且适合 markdown。
其他（`db-tables`、`db-table-schema`）使用默认自定义消息渲染（紫色框 + markdown）——内容小且适合 markdown。

### 关系图数据流

Expand Down
27 changes: 13 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,19 +70,19 @@ connections:

### 命令总览

| 命令 | 说明 |
| --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `/db` | 显示工作区面板：连接状态、可用连接和子命令 |
| `/db add` | 交互式添加连接：选环境 → 连接名 → host/port → 用户名/密码 → 默认数据库；写入 `connections.yaml` 后自动 hot-reload |
| `/db switch` | 切换环境 → 连接 → 数据库 |
| `/db tables` | 列出当前数据库中的所有表 |
| `/db schema [表名]` | 查看表结构（列、索引），以 markdown 表格渲染并持久展示；不带参数显示可搜索的表列表 |
| `/db query [表名\|SQL]` | 查询数据：选表模式或直接执行 SQL（只读，自动追加 LIMIT） |
| `/db history [关键词]` | 搜索查询历史；不带关键词显示最近 20 条 |
| `/db favorite [add]` | 管理收藏的 SQL 模板（按数据库分组） |
| `/db relations [add\|remove\|discover\|er-diagram]` | 管理表关联关系 |
| `/db related` | 以悬浮层浏览器查看最近一次关联查询的关联表（←→ 切表 · ↑↓ 滚动 · Esc 关闭） |
| `/db on` / `/db off` | 会话内启用 / 禁用扩展（见[启用与禁用](#启用与禁用)） |
| 命令 | 说明 |
| --------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `/db` | 显示工作区面板：连接状态、可用连接和子命令 |
| `/db add` | 交互式添加连接：选环境 → 连接名 → host/port → 用户名/密码 → 默认数据库；写入 `connections.yaml` 后自动 hot-reload |
| `/db switch` | 切换环境 → 连接 → 数据库 |
| `/db tables` | 列出当前数据库中的所有表 |
| `/db schema [表名]` | 查看表结构（列、索引），以 markdown 表格渲染并持久展示；不带参数显示可搜索的表列表 |
| `/db query [表名\|SQL]` | 查询数据：选表模式或直接执行 SQL（只读，自动追加 LIMIT） |
| `/db history [关键词]` | 搜索查询历史；不带关键词显示最近 20 条 |
| `/db favorite [add]` | 管理收藏的 SQL 模板（按数据库分组） |
| `/db relations [add\|remove\|discover]` | 管理表关联关系 |
| `/db related` | 以悬浮层浏览器查看最近一次关联查询的关联表（←→ 切表 · ↑↓ 滚动 · Esc 关闭） |
| `/db on` / `/db off` | 会话内启用 / 禁用扩展（见[启用与禁用](#启用与禁用)） |

`/db query` 的三种调用方式 — 参数命中已知表名走选表模式，以 `SELECT` / `SHOW` / `DESCRIBE` / `EXPLAIN` 开头则直接执行：

Expand All @@ -106,7 +106,6 @@ connections:
/db relations add # 注册关系：选源表 → 源列 → 目标表 → 目标列 → 类型
/db relations remove # 删除已注册的关系
/db relations discover # 从 MySQL 外键约束自动发现并导入（可选 AI 分析补充）
/db relations er-diagram [表名] # 以该表为中心生成 mermaid ER 图
```

### LLM 工具
Expand Down
Loading