SchemaSpy：轻松构建数据库文档

文章目录

        SchemaSpy 简介
        SchemaSpy 安装
        SchemaSpy 使用
        总结

大家好，我是只谈技术不剪发的 Tony 老师。

数据库文档对于系统开发至关重要，它可以帮助 DBA、开发和测试人员、数据分析师和数据科学家、技术顾问和维护人员以及业务人员等理解、开发、使用和维护数据库。今天给大家介绍一个用于生成数据库文档的免费开源软件：SchemaSpy。

如果觉得文章有用，欢迎评论📝、点赞👍、推荐🎁
SchemaSpy 简介

SchemaSpy 是一个基于 Java（Java 8 以上版本）的数据库文档工具，用于分析数据库模式中的表结构等元数据并生成基于浏览器的可视化文档。用户可以通过 HTML 链接和实体关系图（ERD）查看数据库中的子表和父表之间的层级关系。

SchemaSpy 是一个免费的软件，基于 LGPL V3 协议发布，源代码位于 GitHub。SchemaSpy 的主要功能包括：

    支持绝大多数 JDBC 兼容的数据库 ；
    生成 ER 图，支持保存为图片；
    显示字段之间的外键关联和级联操作；
    显示存储过程和函数源代码；
    显示视图及定义；
    在注释中支持 Markdown 渲染；
    支持导出为 Excel、CSV 以及 PDF 文件；
    支持额外的元数据，具体参考 SchemaMeta；
    显示数据库中的异常情况，例如没有任何索引的表。

SchemaSpy 提供了一个示例数据库文档，可以让我们直观地感受一下最终的文档结果。例如表的结构：

整体的 ERD：

SchemaSpy 安装

SchemaSpy 基于 Java 开发，我们需要先安装一个 Java 运行环境。安装完成后查看一下版本：

PS C:\Users\tony> java -version
java version "1.8.0_281"
Java(TM) SE Runtime Environment (build 1.8.0_281-b09)
Java HotSpot(TM) Client VM (build 25.281-b09, mixed mode)
PS C:\Users\tony>

SchemaSpy 本身的安装非常简单，它就是一个可执行的 jar 文件，我们可以直接点击下载最新的文件 schemaspy-vX.Y.Z.jar。
SchemaSpy 使用

SchemaSpy 是一个命令行工具，输入以下命令查看帮助信息：

C:\Users\tony>java -jar schemaspy-6.1.0.jar -help
  ____       _                          ____
 / ___|  ___| |__   ___ _ __ ___   __ _/ ___| _ __  _   _
 \___ \ / __| '_ \ / _ \ '_ ` _ \ / _` \___ \| '_ \| | | |
  ___) | (__| | | |  __/ | | | | | (_| |___) | |_) | |_| |
 |____/ \___|_| |_|\___|_| |_| |_|\__,_|____/| .__/ \__, |
                                             |_|    |___/

                                              6.1.0

更多请见： http://www.mark-to-win.com/tutorial/51542.html