pg-documentor
Automatically generate documentation for a PostgreSQL database
Last updated 8 months ago by gfilliere .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install pg-documentor 
SYNC missed versions from official npm registry.

PG Documentor

Automatically generate documentation for a PostgreSQL database

Two outputs are available at the moment :

  • json : this will dump the DB structure in a JSON file
  • hugo : this will generate the necessary content for a hugo generated websites.

Installation :

Install globally or locally using your npm / yarn :

npm install -g pg-documentor
yarn global add pg-documentor

Configuration :

Create a .env file in the folder you'll be running the script, containing a PostgreSQL connection string as accepted by pg-connection-string

DB_CONNECTION_STRING='postgresql://user@uri:PORT/db_name'

Usage :

pg-documentor --format hugo --destination ../path/to/hugo/content/ 
pg-documentor --format json --destination ../path/to/file.json

Additional command line option :

  • --ignored-schemas public : allows ignoring a set of schemas (use a comma separated list of schemas to ignore multiple schemas)

Current Tags

  • 1.0.5                                ...           latest (8 months ago)

6 Versions

  • 1.0.5                                ...           8 months ago
  • 1.0.4                                ...           2 years ago
  • 1.0.3                                ...           2 years ago
  • 1.0.2                                ...           2 years ago
  • 1.0.1                                ...           2 years ago
  • 1.0.0                                ...           2 years ago
Maintainers (1)
Downloads
Today 0
This Week 2
This Month 2
Last Day 1
Last Week 0
Last Month 7
Dependencies (6)
Dev Dependencies (15)
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |