schemaspyでデータベースドキュメントの作成

Schemaspyを使ってデータベースドキュメントを作成します。

環境

SchemaSpy 6.1.0
Java 1.8.0_431
PostgreSQL (supabaseを使いました)

必須条件

Java バージョン 8 以上
または OpenJDK 1.8 以上

手順

1 Schemaspyのjarファイルをダウンロード

githubリリースページから.jar ファイル (例: schemaspy-[version].jar) をダウンロードします。
今回は6.1.0を使用します。

2 デーベースにあったJDBCドライバーをダウンロード

今回はpostgresqlなので　こちらからダウンロードしました。「[データベース名] JDBC ドライバー」を検索することで適切なドライバーを見つけることができます。

3 ファイルで構成を事前定義する

全てコマンドで指定できますが今回は事前定義のファイルを作成します。

schemaspy.properties

# type of database. Run with -dbhelp for details
schemaspy.t=pgsq11
# optional path to alternative jdbc drivers.
schemaspy.dp=./jdbc-driver.jar
# database properties: host, port number, name user, password
schemaspy.host=[ホスト名]
schemaspy.port=[ポート番号]
schemaspy.db=[データベース名]
schemaspy.u=[ユーザ名]
schemaspy.p=[パスワード]
# output dir to save generated files
schemaspy.o=path/to/output
# db scheme for which generate diagrams
schemaspy.s=public

supabaseはサイト内に上記記載があるので参照しながらファイルを作成します。

[実行ディレクトリ]
├── postgresql-42.7.4.jar 　　　　　　　　　　  JDBCドライバ
├── output                                  出力ディレクトリ
├── schemaspy-6.1.0-SNAPSHOT.jar            SchemaSpy本体
└── schemaspy.properties                    設定ファイル

実行ディレクトリに移動してコマンド実行

java -jar schemaspy-6.1.0-SNAPSHOT.jar -configFile schemaspy.properties -vizjs 

outputファイルに出力されたindex.htmlを開くとデータベースドキュメントが確認できます。

補足

データベースドキュメントのcommentsが空欄なので追加したいと思います。

[実行ディレクトリ]
├── postgresql-42.7.4.jar                   JDBCドライバ
├── output                                  出力ディレクトリ
├── schemaspy-6.1.0-SNAPSHOT.jar            SchemaSpy本体
├── public.meta.xml                         コメントの追加のファイル
└── schemaspy.properties                    設定ファイル

コマンド実行

java -jar schemaspy-6.1.0-SNAPSHOT.jar -configFile schemaspy.properties -vizjs -meta ファイルへのパス

参考