Database Documentation Gen 技能:从 PostgreSQL 生成数据字典
EnglishClaude Code 安装步骤
- 从 GitHub 固定提交获取完整的 `plugins/database/database-documentation-gen/skills/database-documentation-gen` 目录。
- 复制到目标项目的 `.claude/skills/`,确认 `.claude/skills/database-documentation-gen/SKILL.md`,再从项目根目录启动 Claude Code,输入 `/database-documentation-gen`。
中文摘要
让 Claude Code 从 PostgreSQL 元数据整理表、字段、外键和索引,生成 Markdown 数据字典供项目交接。
SKILL.md 中文导读
可复现示例
创建本地 publishers 和 titles。让 titles.publisher_id 指向 publishers.id,并为 titles.isbn 添加唯一约束。输出 data-dictionary.md,核对字段、主外键和唯一约束。工作步骤
- 记录表和字段的类型、可空性、默认值与列注释。为缺少业务定义的字段标注待确认。
- 将外键组织成关系表。核对每个约束指向哪张表和哪一列,再与 DDL 抽样对照。
验收方法
文档分别列出两张表,显示 titles 到 publishers 的外键,并记录 isbn 的唯一约束。内容能回查 DDL。
GitHub 原文 · 更新日期
适用环境
准备自己的本地 PostgreSQL 测试库或可信 schema-only 文件。查询线上元数据时使用已有只读权限。
常见问题
没有列注释时可以根据列名补上业务规则吗?
保留类型和约束等可验证事实,将业务含义标记为待确认。
相关指南
相关推荐
groq-install-auth 技能
jeremylongshore/claude-code-plugins-plus-skills
anima-common-errors 技能
jeremylongshore/claude-code-plugins-plus-skills
apple-notes-hello-world 技能
jeremylongshore/claude-code-plugins-plus-skills
castai-hello-world 技能
jeremylongshore/claude-code-plugins-plus-skills
cohere-local-dev-loop 技能
jeremylongshore/claude-code-plugins-plus-skills
figma-security-basics 技能
jeremylongshore/claude-code-plugins-plus-skills