📚

【Rails】ER図くれって言われたのでrails-erd使ってみた

2023/04/15に公開

業務委託エンジニアの方に、ER図が見たいとのことで連絡いただきました。
私の場合DBeaver使っていたので、「それで見てよ！」と思いつつも、まあ見たくなるよなと思い、rails-erd導入して、サクッと作成しつつ、サクッと渡しました。

Rails ERDとは

Rails ERDとは、RailsモデルのER図を自動生成するためのgemパッケージです。
生成したER図は、例えばこのような画像が生成されます。

とにかく簡単にできます。
まずはgemfileに追加。

group :development do
  gem "rails-erd"
end

そのあとお馴染み、

bundle install

最後に、

rake erd

を実行するとPDFで出力されるみたいですね

エラーが出てしまった場合はこちらが参考になりそうです。

便利なgemだなと思いつつ、
そもそも大規模なシステムの場合、ER図は複雑になりがちで見づらい全体像が出てくるだけなので、
タスクを通じて全体像を把握するほうが早い気もしました。