コード日進月歩

しんくうの技術的な小話、メモ、つれづれ、など

PlantUMLでER図を書く

Web開発からスタートするとあまり触ることのないUML。それを使ってER図を書く

今回の記事の端末環境

macOS Mojave
ver 10.14.1

homebrew導入済み

$ brew --version
Homebrew 1.8.4
Homebrew/homebrew-core (git revision c1ab; last commit 2018-11-30)

準備

graphvizを入れる

brew install graphviz

Editorを用意する

お好みのIDEプラグインを使うもよし * Visual Studio Code で UML を描こう! - Qiita * IntelliJ IDEAでPlantUMLを書く - Qiita * AtomとPlantUMLで爆速UMLモデリング - Qiita

見るだけぐらいならWebでも提供されているのでそちらでも

記述例

今回はapplication_schemaというDBSchemeの中にuserテーブルとそれに紐づくmessagesテーブルを表現する

@startuml

package "スキーマ" as application_scheme <<Database>> {

    entity "users\nユーザ" as users <<M,AAFFAA>> {
        + id [サロゲートID][PK]
        --
        name [名前]
        created_at [作成日]
        updated_at [更新日]
    }

    entity "messages\nメッセージ" as messages <<M,AAFFAA>> {
        + id [サロゲートID][PK]
        --
        - user_id [ユーザID]
        created_at [作成日]
        updated_at [更新日]
    }



users ---left--|{ messages

@enduml

こんな感じで書くと、以下のような図が出来上がる

PlantUMLで書いたER図
PlantUMLの出力結果

参考リンク