rails-ERD를 사용하여 쉽게 ER 다이어그램을 만듭니다.

소개

직장에서 Rails로 만들어진 제품의 최신 ER 그림을 만들려고 하는 일이 있어, 번거롭기 때문에 좋은 라이브러리가 없을까라고 조사했더니 rails-erd가 있었으므로 공유한다.

준비

우선, OS에 graphviz라는 툴 패키지를 인스톨 한다.
Graphviz(Graph Visualization Software)란?
DOT 언어의 스크립트로 표시된 그래프를 그립니다.
그래프 설명에는 충분한 자유도가 준비되어 있어, 화살표 하나로 해도 많은 바리에이션 중에서 적절한 것을 선택할 수 있다.
htps : // 그럼.ぃきぺぢ아. 오 rg / uuki / G 등 ph ぃ z

이번에는, 이 그래프 그리기를 간단하게 하는 툴을 사용하는 gem인 것 같습니다.

빨리 넣어 보자.

우분투

$ sudo apt-get install graphviz

Gemfile

group :development, :test do
  gem 'rails-erd'
end

Mac

$ brew install graphviz

Gemfile

group :development, :test do
  gem 'rails-erd'
end

실행

다음을 프로젝트 디렉토리에서 실행합니다.

$ bundle exec erd

ER 다이어그램

옵션

help

$ erd -h

Usage: erd [-v]


        --title=TITLE                Replace default diagram title with a custom one.
        --notation=STYLE             Diagram notation style, one of simple, bachman, uml or crowsfoot.
        --attributes=TYPE,...        Attribute groups to display: content, primary_keys, foreign_keys, timestamps and/or inheritance.
        --orientation=ORIENTATION    Orientation of diagram, either horizontal (default) or vertical.
        --inheritance                Display (single table) inheritance relationships.
        --polymorphism               Display polymorphic and abstract entities.
        --direct                     Omit indirect relationships (through other entities).
        --connected                  Omit entities without relationships.
        --only                       Filter to only include listed models in diagram.
        --exclude                    Filter to exclude listed models in diagram.


        --filename=FILENAME          Basename of the output diagram.
        --filetype=TYPE              Output file type. Available types depend on the diagram renderer.
        --no-markup                  Disable markup for enhanced compatibility of .dot output with other applications.
        --open                       Open the output file after it has been saved.


        --help                       Display this help message.
        --debug                      Show stack traces when an error occurs.
    -v, --version                    Show version and quit.