Categorygithub.com/kaishuu0123/erd-go
modulepackage
2.0.0+incompatible
Repository: https://github.com/kaishuu0123/erd-go.git
Documentation: pkg.go.dev

# README

erd-go

GitHub release Build Status Coverage Status Docker Pulls

Translates a plain text description of a relational database schema to a graphical entity-relationship diagram.(convert to dot file)

ER diagram for nfldb

Install

get binary from releases page.

or

go get github.com/kaishuu0123/erd-go

or (for Mac)

brew tap kaishuu0123/erd-go
brew install erd-go

Usage

Usage:
  erd-go [OPTIONS] PATTERN [PATH]

Application Options:
  -i, --input=  input will be read from the given file.
  -o, --output= output will be written to the given file.

Help Options:
  -h, --help    Show this help message

support input from STDIN.

cat examples/nfldb.er | erd-go

ex.) convert to png from dot (use dot command)

cat examples/nfldb.er | erd-go | dot -Tpng -o nfldb.png

Usage (Used by Docker container)

cat examples/nfldb.er | docker run --rm -i kaishuu0123/erd-go | docker run --rm -i risaacson/graphviz dot -T png > nfldb.png

Example

see examples directory

Build Instruction

  1. install glide

    go get github.com/Masterminds/glide
    
  2. install go-bindata

    go get github.com/jteeuwen/go-bindata
    
  3. install peg

    go get github.com/pointlander/peg
    
  4. make

    make
    

LICENSE

MIT

Credits

This work is based off of several existing projects:

# Functions

Asset loads and returns the asset for the given name.
AssetDigest returns the digest of the file with the given name.
AssetDir returns the file names below a certain directory embedded in the file by go-bindata.
AssetInfo loads and returns the asset info for the given name.
AssetNames returns the names of the assets.
AssetString returns the asset contents as a string (instead of a []byte).
Digests returns a map of all known files and their checksums.
MustAsset is like Asset but panics when Asset would return an error.
MustAssetString is like AssetString but panics when Asset would return an error.
No description provided by the author
RestoreAsset restores an asset under the given directory.
RestoreAssets restores an asset under the given directory recursively.
No description provided by the author

# Structs

Column in a table.
Erd of the database.
Index on a column.
Options for the command line tool.
No description provided by the author
Relation between two tables.
Table in a database.
Title ...