SuperAPI AI 工具集

database-documentation-gen

数据与分析

查看项目

更新于 10-16 06:20

技能介绍

用途:为 PostgreSQL 或 MySQL 数据库自动生成可读文档,适合团队上手、审计与合规场景。

主要能力:内省 information_schema、pg_catalog 或 MySQL 系统表,提取表清单、列详情(类型、可空、默认值、注释)、主键与唯一约束、外键关系、索引、视图定义、函数与存储过程;生成 Markdown 数据字典、实体关系说明(含一对多、多对多)、索引目录、视图说明及表大小与行数统计。

使用方式:需具备对 information_schema、pg_catalog 或系统表的只读权限,使用 psql 或 mysql CLI 执行内省查询,并指定输出目录。资料给出了 PostgreSQL 与 MySQL 的表、列、约束、外键、索引、视图、例程及统计查询示例,可按需执行后整理为 Markdown。

适用场景:电商等中等规模库的文档生成、新成员上手材料、合规审计文档(含约束、检查规则、默认值,并可标记疑似 PII 列)。

限制:缺少列注释时需推断描述并标记待人工补充;pg_catalog 权限受限时可申请 pg_read_all_settings 或改用 pg_dump --schema-only;500+ 表的大库建议按 schema 或模块拆分并建目录索引;自定义类型需查询 pg_type;模式变更后需重新生成,可集成到 CI/CD。具体收费、平台与效果资料未提供。