Rails ERDでER図を自動的に出力する
はじめに
人の追加や案件の引き継ぎなどに際して、データベースの構造を説明するシーンは、割りと頻繁にあることかと存じます。そういった時に便利なのが、データベースのスキーマからER図を自動生成してくれるRails ERDです。
実装
Rails ERDをインストールします。
gem install rails-erd
RailsERDは内部でgraphvizを利用しているので、こちらもインストールします。以下はmacでhomebrewを利用している場合です。
brew install graphviz
ER図の生成はerdコマンドを実行することで行なえます。
bundle exec erd
また、上記のコマンドを実行するに際して、色々とオプションを指定することが可能です。オプションはRailsのrootディレクトリに、.erdconfigファイルを配置することで指定が可能です。
コマンドラインからでも指定は可能ですが、後々のことを考えますと、.erdconfigファイルを配置しておいたほうが便利かと存じます。尚、オプションの一覧については、こちらをご確認下さい。
シンプルながら、非常に便利なgemです。
Railsでアプリを作成する際には、結構な割合で入れております。