SchemaCrawler 数据库模式清单与审查文档生成
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3c6cb52e/inventory-live-database-schemas-and-generate-reviewable-docs-before-risky-sql-changes-with-schemacrawler。
技能介绍
为什么需要模式清单
在长期迭代的业务系统中,数据库结构往往会随着需求频繁变更而变得臃肿且难以追踪。当准备执行高风险的 DDL 变更或数据库迁移时,团队往往缺乏对线上实际表结构、外键约束和索引依赖的全局视野,这不仅容易引发意料之外的级联故障,还可能在夜间停服窗口造成严重的锁表阻塞。此外,在系统交接或跨团队联调时,过时或缺失的文档也会极大增加沟通成本。
核心能力与工作步骤
该技能通过调度 Agent 调用 SchemaCrawler CLI 工具,直接连接并探查活跃数据库,将其转化为结构化的审查材料。其核心工作流包含以下关键步骤:
- 元数据提取:自动扫描目标数据库,生成包含表、列、索引及视图的完整模式清单(Schema Inventory)。
- 依赖关系梳理:解析外键和关联约束,构建清晰的表间依赖视图(Dependency Views),帮助工程师预判变更影响面。
- 生成审查文档:将上述信息渲染为易读的 Markdown 或文本文档,作为变更方案设计(Design Review)的基准参考。
适用边界与注意点
使用该技能前,运行环境需预先配置好 Java 运行时、SchemaCrawler CLI 以及目标数据库对应的 JDBC 驱动。由于上游项目未提供自动化的安装与使用脚本,在将其接入敏感的自动化运维流水线前,务必手动审查其上游源码以确保安全性。强烈建议在正式变更前,先在数据库的只读副本上执行盘点操作,避免对主库性能造成潜在影响。
使用场景
- 在执行高风险的 DDL 变更前,需要全面盘点线上数据库的表结构、索引和外键,生成审查文档以评估影响面。
- 准备对核心业务库进行版本升级和数据迁移时,需梳理活跃库的完整模式清单和表间依赖视图,作为回滚预案的基准。
- 在资深 DBA 离职交接或跨团队联调时,需针对遗留系统生成准确、可读的数据库结构文档,降低沟通与理解成本。
适合人员
- 需要执行复杂 DDL 变更的后端工程师,希望在修改线上表结构前明确级联影响,避免引发生产事故。
- 负责核心数据库迁移与升级的 DBA,需要获取线上活跃库的完整依赖视图,以制定安全的迁移与回滚方案。
- 接手遗留系统或进行跨部门联调的技术负责人,需要快速获取准确的数据库结构文档,降低团队间的认知壁垒。