More than 1 year has passed since last update.

簡単、手軽にER図を作成し、GitHub上で表示させる方法

Last updated at 2024-01-07Posted at 2024-01-06

はじめに

この記事は、

データベース設計のER図作成
GitHub上にER図を表示

この二つを簡単手軽に行う方法を説明します。

ER図作成

まずはデータベースの設計を考えます。
設計の構想に関しては今回は既に済ませてあるものとして、

その考えをER図に表したい！
ER図を書きながら考えたい！

という風になると思います。
しかし同時に、以下のような気持ちにもなります。

ER図を書くための環境準備が面倒！
時間がない！

そんな時に利用したいのがオンラインで使うPlantUMLです。

Web版plantUML

こちらのPlantUMLでコードを入力します。

まず@startumlを入力した後は、各テーブル(エンティティ)を下記のように入力していきます。

plantUMLコード表示

plantuml.md

@startuml internet_tv
' チャンネル
entity "channels"{
  +channel_id [PK]
  ==
  channel_name:varchar(100)
}
' 番組チャンネル
entity "channel_programs"{
  #channel_id [FK(channels,id)]
  #program_id [FK(program,id)]
  time_slot:datetime
}
' 番組
entity "programs"{
  +program_id [PK]
  ==
  *title:varchar(100)
  description:text
}
' シーズン
entity "seasons"{
  +season_id [PK]
  ==
  #program_id [FK(programs,id)] 
  season_number:int 
}
' エピソード
entity "episodes"{
  +episode_id [PK]
  ==
  #season_id [FK(seasons,id)]
  title:varchar(100)
  episode_no:int
  duration:time
  release_date:date
  description:text
  views:int default 0
}
' ジャンル
entity "genres"{
  +genre_id [PK]
  ==
  *name:varchar(50)
}
' 番組ジャンル
entity "program_genres"{
  #program_genres_id:int[FK(channels,id)]
  #genre_id [FK(genres,id)]
  
}
' 視聴数
entity "views"{
  #episode_id [FK(episodes,id)]
  #channel_id [FK(channels,id)]
  time_slot:datetime
  view_count:int
}

その下にリレーションを下記のように入力し、関連性を示した後で@endumlを入力。

plantUMLコード表示

plantuml.md

'リレーション

channels ||--o{ channel_programs
programs ||--o{ channel_programs
programs ||--o{ program_genres
programs ||--|{ seasons
seasons   ||--|{ episodes
episodes  ||--o{ views
genres    ||--o{ program_genres
program_genres ||--o{ programs
channel_programs ||--o{ channels
channel_programs ||--o{ programs
views ||--o{ episodes

@enduml

するとプレビューに以下のようなER図が表示されます。

ER図