hene

hene.dev

rails-erd を使った ER 図 の生成

rails-erd を使った ER 図 の生成

rails-erd という gem を使って、 ER図 を生成したときのメモ。

Gemfile に追加

# gemfile

group :development do
  gem 'rails-erd'
end

rails-erd のインストール

$ bundle install

ER 図の生成

ER図erd.pdf として生成する。

$ bundle exec erd

オプションをつけて実行

プライマリーキーや created_atupdated_at を含めた ER図erd.png として生成する。

$ bundle exec erd --attributes=foreign_keys,primary_keys,content,timestamp --filename=erd --filetype=png

.gitignore

生成した ER図 も一緒にコミットしてしまいそうなので、 .gitignore に追加しておいた。

# .gitignore

erd.pdf
erd.png

参考

関連記事