Macでrails-ERD を使った ER 図 の作成法

はじめに

現在、作成しているアプリで、rails-ERDによるER図を作成したので、その方法を備忘録として残します。これを使用することでデータモデルの構造や関係性を示したER図（Entity Relationship Diagram）が自動作成され、以下のようなPDFファイルを作成することができます。

前提条件

• ER図の作成対象となるアプリが作成されており、モデル作成とリレーション設定が済んでいること
• Graphviz(グラフビズ)がインストールされていること

ER図作成の流れ

1.Gemfileの変更

Gemfile.

group :development do
  gem 'rails-erd'  #追記
end

2.rails-erd のインストール

ターミナル.

$ bundle install --path vendor/bundle

3.ER図の作成

ターミナル.

$ bundle exec erd

Gemfile等と同じ階層にerd.pdfが作成されていればOKです。

おまけ

今回が初めてrails-erdを使用したので当然Graphvizはインストールされてませんでした。その状態でbundle exec erdを実行すると怒られたのでGraphvizをインストールしました。

ターミナル.

$ bundle exec erd
Failed: RuntimeError: Saving diagram failed!
Verify that Graphviz is installed and in your path, or use filetype=dot.

$ brew install graphviz

作成したER図が他と一緒にコミットされないよう除外しました。

gitignore.

<中略>

erd.pdf　#追記

参考

https://www.sejuku.net/blog/66196
https://tech.mof-mof.co.jp/blog/try-rails-erd.html