Need help with planter?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

achiku
231 Stars 23 Forks MIT License 16 Commits 6 Opened issues

Description

Generate PlantUML ER diagram textual description from PostgreSQL tables

Services available

!
?

Need anything else?

Contributors list

planter

Build Status GitHub license Go Report Card

Generate PlantUML ER diagram textual description from PostgreSQL tables

Why created

A team with only software engineers doesn't need ER diagram that much as long as they have decent experience in Relational Database modeling. However, it becomes very helpful to have always-up-to-date ER diagram when marketing/promotion/operation teams consisting of those who are fluent in writing/reading SQL, join to the game.

PlantUML supports ER diagram in the latest version with this awesome pull request. The tool, planter, generates textual description of PlantUML ER diagram from pre-existing PostgreSQL tables, and makes it easy to share visual structure of relations with other teams.

Installation

go get -u github.com/achiku/planter

Quick Start

$ planter postgres://[email protected]/planter?sslmode=disable -o example.uml
$ java -jar plantuml.jar -verbose example.uml

er diagram

Specify table names

planter postgres://[email protected]/planter?sslmode=disable \ 
    -t order_detail \
    -t sku \
    -t product

Help

$ planter --help
usage: planter [] 

Flags: --help Show context-sensitive help (also try --help-long and --help-man). -s, --schema="public" PostgreSQL schema name -o, --output=OUTPUT output file path -t, --table=TABLE ... target tables -x, --xtable=TABLE ... exclude target tables

Args: PostgreSQL connection string in URL format

Test

install dependencies.

go get -u github.com/mattn/gom
gom install

setup database.

create database planter;
create user planter;

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.