Yml2erd

yml2erd allows us to generate erd easily.

When I consider database structure, I wanted erd generator. However there are no tools to fit. So I created.

Installation

Before install this gem, you need to install graphviz.

$ brew install graphviz

You can get more from here

Add this line to your application's Gemfile:

gem 'yml2erd'

And then execute:

$ bundle

Or install it yourself as:

$ gem install yml2erd

Usage

Run this,

$ yml2erd convert structure.yml

and we get output.png.

$ yml2erd help convert
Usage:
  yml2erd convert <path>

Options:
  o, [--output=FILE_PATH]          # default: output.png
  p, [--projectname=PROJECT_NAME]
  s, [--outputstyle=OUTPUT_STYLE]  # svg or png, default: png

Convert erd from yml

Rule

You must write yml just like below

<table_name>:
  columns:
    - <column_name>: <column_type>
  relations:
    belongs_to:
      - <table_name>
    has_many:
      - <table_name>
  index:
    - <column_name>

belongs_to or has_many is not necessary.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/asmsuechan/yml2erd.

License

The gem is available as open source under the terms of the MIT License.