Draw DB diagrams using GraphViz / Dot from a very simple YAML file
JavaScript HTML Shell
Switch branches/tags
Nothing to show
Clone or download
Latest commit c247da4 Feb 16, 2016

README.md

DB DiaYAML - A simple way to plan database schemas

Draw database diagrams using GraphViz / DOT from a very simple YAML file.

Live (Mini) Web Service

There is a live editing available at http://forbesmyester.github.io/db-diayaml/. It does not save any code anywhere so make sure to copy & paste into VIM or something.

Mini web service uses [https://github.com/mdaines/viz.js](mdaines viz.js)

Example YAML File

person: # A Table
    name: # A Field
address:
    line1:
    line2:
    person: # Link adds a foreign key (missing field implies `id`, will be added if not already existing!)
    link: person
order:
    address: address # Shorter version of a foreign key
a:
    letter:
        link: person.name # A foreign key to a specific field
b:
    id:
    something:

Example Output

Output of above example

Usage

Output a GraphViz / Dot file from a simplified YAML file

Usage

--help            Print usage instructions
--file <array>    The input file (there can be many, but only the first will be
                  read!)
--json            Use a JSON file instead of the default YAML


YAML Usage:

  node index.js test/dbdiagram.yaml | dot -Gdpi=64 -Tpng:cairo:cairo > bin/dbdiagram.png && display.im6 bin/dbdiagram.png

JSON Usage:

  node index.js --json test/dbdiagram.json | dot -Gdpi=64 -Tpng:cairo:cairo > bin/dbdiagram.png && display.im6 bin/dbdiagram.png