ymlから簡単にerdを生成するyml2erdを作った

Posted at 2017-03-20

先日複数人でDB設計をしている時「erdあった方が分かりやすいから作ろう」って話になり作ろうとしたのですが簡単にerdをｼｭｯと生成するツールが見つからなかったので作りました。

既存ツールとしてMySQL Workbenchなどあるにはあるのですが、作るのが面倒くさい + 作り方覚えるのが面倒くさい + 手でﾎﾟﾁﾎﾟﾁするのしんどいみたいな感じだったので自作の道を選びました。

また、Haskell製のerdというツールもあるのですが使いこなせませんでした・・・

インストール

まず、graphvizという描画ツールをインストールします。macなら

$ brew install graphviz

で入ります。他はこちらを参考にしてください。

次に、yml2erdをインストールします。

$ gem install yml2erd

これでインストールできました。

インストールができたら実際にerdを生成します。今回はsample.ymlを使用します。

$ yml2erd convert sample.yml

これで生成されたoutput.pngがerdとなります。また、生成するファイルはパス指定できて

$ yml2erd convert sample.yml -o hoge.png

とするとhoge.pngが生成されます。

pngだけでなくsvgでも出力できます。詳しくはREADMEを参照してください。

基本的には以下の形式です。間違ってたらエラーが出ます。

<テーブル名>:
  columns:
    - <カラム名>: <カラムの型>
  relations:
    belongs_to:
      - <テーブル名>
    has_many:
      - <テーブル名>