schemaspy
v6.2.4
SchemaSpy是一个数据库元数据分析器。它可以帮助您的数据库管理员和开发人员可视化、导航和理解您的数据模型。借助易于使用的基于 HTML 的报告，遍历实体关系图从未如此简单。我们的产品展示位于 http://schemaspy.org/sample/index.html。
SchemaSpy 是一个没有 GUI 的独立应用程序。只需下载最新的 JAR 文件或 Docker 映像即可开始使用！要从 Maven 使用 SchemaSpy，请参阅下面的 Maven 章节。
# replace '6.2.4' with latest version
curl -L https://github.com/schemaspy/schemaspy/releases/download/v6.2.4/schemaspy-6.2.4.jar
--output ~/Downloads/schemaspy.jar
对于未发布的错误修复和正在进行的功能，请下载我们的快照 JAR 或使用 Docker 标签
snapshot
SchemaSpy 发布两种类型的 JAR 文件：裸机 JAR 和包含所有依赖项的胖 JAR。这两个 JAR 均发布到 Maven Central。 fat JAR 还附加到 GitHub 上的版本中。本页顶部的“Maven Central”徽章将带您直接进入 Maven Central 的最新版本。
两个工件的Maven GAV如下：
org.schemaspy:schemaspy:<version>org.schemaspy:schemaspy:<version>:app ← 注意app分类器假设您使用的是 PostgreSQL（11 或更高版本）。首先，下载他们的 JDBC 驱动程序。
curl -L https://jdbc.postgresql.org/download/postgresql-42.5.4.jar
--output ~/Downloads/jdbc-driver.jar
然后针对您的数据库运行 SchemaSpy，您就可以在DIRECTORY/index.html中浏览它了。
java -jar ~/Downloads/schemaspy.jar
-t pgsql11
-dp ~/Downloads/jdbc-driver.jar
-db DATABASE
-host SERVER
-port 5432
-u USER
-p PASSWORD
-o DIRECTORY
如果您没有使用 PostgreSQL，请不要惊慌！ SchemaSpy 开箱即用，支持十多种不同的数据库。使用-dbhelp列出它们。还不够吗？只要您的数据库有 JDBC 驱动程序，您就可以将其插入 SchemaSpy。
我们在“阅读文档”上托管我们的文档。请务必查看有关解决常见问题的部分。
SchemaSpy 涵盖了许多数据库分析和文档的用例。请务必查看本自述文件后面社区提供的指南。
记录数据库的首选方法是通过实体关系 (ER) 图。然而，手动绘制这些图表是一个非常耗时且容易出错的过程，因此我们在实践中几乎不会绘制它们。当绘制图表时，它们很少保持最新状态。有了 SchemaSpy，这不再是问题。这些图表可以快速生成，甚至可以作为 CI/CD 工作流程的一部分，以确保其始终保持最新状态。
SchemaSpy 可以收集各种有趣的统计数据来描述数据库结构的形状和形式。直接在报告中深入了解这些统计数据，或将其导出到 Excel 或 CSV 以进行进一步的 QA 分析。
如今，公司的数据可能是他们最有价值的资产。由于 SchemaSpy 仅读取结构信息，因此它在空数据库副本上也能正常工作。这意味着可以毫无顾虑地共享该报告以供第三方分析。
SchemaSpy 融合了有关数据库设计最佳实践的知识。它可以定位并报告异常情况，例如丢失索引、隐含关系和孤立表。
欢迎来到 SchemaSpy 社区！只要阅读此文件或使用该工具，就意味着您是我们社区的一部分，并为项目的未来做出贡献。我们很高兴有你和我们在一起！
我们的一些社区成员付出了额外的努力与更多人共享 SchemaSpy，要求他们的公司提供经济援助，或者决定改进该软件。我们希望有足够的空间来单独感谢你们每一个人，因为每一个 Github 明星、推文或其他活动都提醒我们，我们的工作受到赞赏。
用于创建 SchemaSpy 的前五个版本：
从那时起，为了使 SchemaSpy 永久存在：
用于为社区创建教程和指南：
我们很自豪地注意到 SchemaSpy 可以协助研究人员的工作。
要引用 SchemaSpy，请使用：
SchemaSpy Team (2024) SchemaSpy: Database documentation built easy. SchemaSpy. URL https://schemaspy.org/
LaTeX 用户的 BibTeX 条目是：
@Manual{schemaspy,
title = {SchemaSpy: Database documentation built easy},
author = {{SchemaSpy Team}},
organization = {SchemaSpy},
year = {2024},
url = {https://schemaspy.org/}
}
SchemaSpy 是使用 Maven 构建的，我们使用 Maven 包装器。
Windows mvnw.cmd package
Linux ./mvnw package
生成的应用程序可以在target中找到
您需要自己的 SonarQube：
https://hub.docker.com/_/sonarqube/
Windows mvnw.cmd -P sonar clean verify -Dsonar.host.url=http://$(boot2docker ip):9000 -Dsonar.jdbc.url="jdbc:h2:tcp://$(boot2docker ip)/sonar"
Linux ./mvnw -P sonar clean verify
观看结果：
Linux http://localhost:9000
Windows http://$(boot2docker ip):9000
使用Python构建
创建venv
安装依赖项pip install -r docs/requirements.txt
导航到docs
Windows make.bat clean && make.bat html
Linux make clean html
生成的文档可以在docs/build/html中找到
