db-diayaml

0.9.8 • Public • Published

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

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

Readme

Keywords

none

Package Sidebar

Install

npm i db-diayaml

Weekly Downloads

2

Version

0.9.8

License

MIT

Last publish

Collaborators

  • forbesmyster