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 の 2 種類の JAR ファイルをリリースします。どちらの JAR も Maven Central に公開されます。ファット JAR は、GitHub 上のリリースにも添付されています。このページの上部にある「maven Central」バッジを使用すると、Maven Central の最新バージョンに直接アクセスできます。
2 つのアーティファクトの 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 にプラグインできます。
私たちはドキュメントを Read the Docs でホストしています。一般的な問題のトラブルシューティングに関するセクションを必ず確認してください。
SchemaSpy は、データベース分析と文書化のための多くのユースケースをカバーしています。この README の後半でコミュニティが提供するガイドを必ず確認してください。
データベースを文書化するための推奨される方法は、エンティティ関係 (ER) 図を使用することです。ただし、これらの図を手動で描くのは非常に時間がかかり、間違いが発生しやすいプロセスであるため、実際に図を描くことはほとんどありません。描画された図が最新の状態に保たれることはほとんどありません。 SchemaSpy を使用すると、これはもう問題ありません。図は、CI/CD ワークフローの一部として迅速に生成でき、常に最新の状態を保つことができます。
SchemaSpy は、データベースの構造の形状や形式を説明するために、さまざまな種類の興味深い統計を収集できます。これらの統計をレポート内で直接掘り下げたり、Excel または CSV にエクスポートしてさらに QA 分析を行ったりできます。
今日、企業のデータは最も貴重な資産となり得ます。 SchemaSpy は構造情報のみを読み取るため、空のデータベース レプリカでも同様に機能します。これは、レポートを第三者による分析のために恐れることなく共有できることを意味します。
SchemaSpy には、データベース設計のベスト プラクティスに関する知識が組み込まれています。インデックスの欠落、暗黙の関係、孤立テーブルなどの異常を特定して報告できます。
SchemaSpy コミュニティへようこそ!このファイルを読んだり、ツールを使用したりするだけで、あなたはコミュニティの一員となり、プロジェクトの将来に貢献することになります。よろしくお願いします！
私たちのコミュニティ メンバーの中には、SchemaSpy をより多くの人々と共有するために特別な努力を払ったり、会社に資金援助を依頼したり、ソフトウェアの改善を決意したりする人もいます。 Github のスター、ツイート、その他の活動はすべて、私たちの仕事が評価されているということを思い出させるので、皆さんに個別に感謝する機会があればよかったと思います。
SchemaSpy の最初の 5 つのバージョンを作成するには:
それ以来、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にあります。
