Railsで開発をしているときデータベース設計をすることはないが、ER図を見せることがあったのでrails-erdで作ってみる。
完成したER図
PDFでいい感じに作ってくれる。テーブル名を変更したり色々なオプションがるので細かく書く必要があれば都度修正できる。
やること
graphvizをインストール
brew install graphvizでインストールできる。LInuxやWindowsはDownload | Graphvizを参考にインストールできる。
rails-erdをインストール
Gemfileに以下の行を追加すしてbundle installする。
gem 'rails-erd', group: :developmentrails-erdの初期設定
bundle exec rails g erd:installでlib/tasks/auto_generate_diagram.rakeファイルができる。
ここでbundle exec rails db:migrateを実行すると以下のエラーが出る。
Running via Spring preloader in process 27
rake aborted!
NameError: uninitialized constant RailsERDRails 7から初期化の呼び出しの順番が変わったみたい？解決方法がわからなかったため、コメントアウトすることにする。migration時に自動でER図を更新しないようにする。
if Rails.env.development?
# RailsERD.load_tasks # migration時には何もしない
endlib/tasks/auto_generate_diagram.rakeファイルを削除しても良い。
ER図を作成
bundle exec erdでerd.pdfができる。
終わりに
とても簡単にER図を作成することができた。
そもそもER図を見せることがあまりないので使うことはなさそうだが、いつか使えるかも。
初見の人向けのプロジェクト説明として使う場合は、誤解を与えないか注意する必要がある。
コメント