rails-logo

[ Rails ] Rails ERDでER図を自動作成する方法

こんにちは。たなかです。
Railsで開発していると、テーブル同士の関連性を一括確認したいことあると思います。いわゆるER図というやつです。

モデルの関連付け確認して、紙とペン用意して紐づけて……ってやるのは簡単なアプリならまだしも、複雑化したシステムではシンドいものがあります。ミスったら意味ないですしね。

ということでRailsでER図を自動生成してくれるgemパッケージ「Rails ERD」についてご紹介しようかと思います。

 

コマンド一つで↓のような図を出力できるようになります。

erd

Rails ERD使い方

前提

Rails ERDを利用するにはGraphviz(グラフビズ)というグラフ描画ツールが必要です。

MacOSの場合はこちらをHomebrewにてインストールします。

$ brew install graphviz

成功したらgemの導入です

 

Gemfileにrails-erdを追加

group :development  do
  gem 'rails-erd'
end

bundle installしたら導入完了。簡単です。

ER図出力方法

 

bundle exec erd 

上記のコマンドで Diagram saved to ‘erd.pdf’. といったメッセージが出ればpdfファイルが出力されたはずです。

他にもオプションで–filetype=TYPEなどを設定してやれば好きな形式で出力が可能です。

 

まとめ

 

ということでRailsERDのお話でした。

ER図出力したら、大きい紙とかに印刷して手元みながら作業するとやりやすいっすね。アナログですが。
画像形式に出力できるとメンバーへの共有とか、テーブルの追加・削減なんかも一目瞭然なので何かと便利。

使ったことない方はぜひ利用してみてはいかがでしょうか。
今回はここまで。

スポンサードリンク