JIG-ERD

ざっくりなER図を出力します。 現在はH2DatabaseとPostgreSQLに対応しています。

関連だけに着目したデータベース設計の補助道具です。

PKや列のデータ型、その他制約と言った一般的なER図で必須な項目は扱っていません。対応予定もないです。詳細な情報は他のツールの使用をお勧めします。

• Schema Spy
• tbls
• planter
• PlantERD

サンプル

以下は system-sekkei/library で出力したサンプルです。3種類のダイアグラムが出力されます。

• jig-erd-overview.svg: スキーマのみ
• jig-erd-summary.svg: スキーマ、テーブルのみ
• jig-erd-detail.svg: スキーマ、テーブル、外部キーカラム

ファイル名、形式は設定で変更できます。

スキーマのみ

スキーマ、テーブルのみ

テーブル名を _ ではじめると色が変わります。

スキーマ、テーブル、外部キーカラム

前提条件

• Java11以降がインストールされていること
• Graphvizがインストールされていること
  • 出力形式を DOT にした場合は不要。この場合は自分で変換を行ってください。

対象バージョン

H2 Database Engine 1.4.200 以前を対象にする場合、jig-erd 0.0.11 以前を使用してください。

動作確認環境

Getting Started

コマンドラインから使う

既にテーブル作成済みのDBに対して実行したい場合。

• jig-erd-x.x.x.jarをダウンロード
  • Maven Central Repository などから
• JDBCドライバ（ postgresql-42.2.14.jar など ）をダウンロード
  • JDBCドライバダウンロードページ などから
• 実行

java -cp jig-erd-x.x.x.jar:postgresql-42.2.14.jar \
    jig.erd.JigErd {url} {user} {password}

url, user, passは適宜置き換えてください。urlは jdbc:postgresql://localhost:5432/test とかです。

Spring Boot Testで使う

SpringBootが schema.sql などを使用してセットアップしたDBのERDを出力します。 依存に追加して、テスト経由で実行します。

Gradle

repositories {
    mavenCentral()
}

dependencies {
    testImplementation 'com.github.irof:jig-erd:latest.release'
}

Maven

<dependencies>
    <dependency>
        <groupId>com.github.irof</groupId>
        <artifactId>jig-erd</artifactId>
        <version>[0.0.12,)</version>
        <scope>test</scope>
    </dependency>
</dependencies>

@SpringBootTest
public class Erd {

    @Test
    void run(@Autowired DataSource dataSource) {
        JigErd.run(dataSource);
    }
}

他の出力例は wiki を参照してください。

設定

jig.properties ファイルをクラスパスか実行時のカレントディレクトリに配置してください。

# サンプル
jig.erd.output.directory=./build
jig.erd.output.prefix=library-er
jig.erd.output.format=png
jig.erd.output.rankdir=LR

ファイル名は {jig.erd.output.prefix}-detail.{拡張子} などになります。

正規表現にマルチバイト文字を使用する場合の jig.properties は UTF-8 で記述してください。

リリース

• gradle.properties などで設定
  • 署名: signing.keyId signing.password signing.secretKeyRingFile
  • リポジトリの認証: ossrhUsername, ossrhPassword

VERSION=X.X.X ./gradlew publish

https://s01.oss.sonatype.org/#stagingRepositories からCloseとRelease

LICENSE

Apache License 2.0