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中找到
