rails-erd 是为 ruby on rails 生成 entity-relationship diagrams(实体关系图)的 gem,rails-erd 使用 Graphviz(一个开源的可视化图形软件) 生成实体关系图,所以使用 rails-erd 之前要确保机器上安装了 graphviz.
如果没有安装 grapphviz,则需要先安装 graphvize,下面是 mac 机器和 linux 内核机器上安装 graphviz
brew install graphviz
或者
sudo port install graphviz
sudo aptitude install graphviz
备注:当然 apt-get install 也是可以的
group :development do
gem 'rails-erd'
end
bundle install
执行rake erd
就生成实体关系图了(当然使用的的是默认参数,生成的实体关系图可能不符合你的要求,可以指定各个可用属性来生成满足自己需求的实体关系图)
title
rake erd title='my models relationship'
指定生成的图表的名字
filename
rake erd filename='my_application_model' filetype='dot'
指定生成的图标文件的名字和格式,默认的名字为 ERD,默认的格式为 pdf,所以一般就不用修改格式了
indirect
rake erd indirect=true
显示两个模型间间接的关系,即通过 has_many :comments, through: :blogs 关联的两个模型的关系
inheritance
rake erd inheritance=true
是否显示继承关系,主要用于单表继承,默认是 false,不显示单表继承,如果想显示单表继承的关系将值设置为 true
rails-erd 的官方地址:http://voormedia.github.io/rails-erd/