PostgresDescribe v0.1.0 PostgresDescribe View Source

This library provides a Mix task that documents PostgreSQL database tables in files within the directory tree.

Link to this section Summary

Functions

Main entry point into PostgresDescribe’s library code

Link to this section Functions

Main entry point into PostgresDescribe’s library code.

Pulls configuration from the environment. The following configuration keys are the minimum required. An example can be found in the README.

  • host # Your PG host
  • port # PG port
  • user # Your PG user
  • password # Your PG password
  • database # Your PG database name
  • write_dir # Where we should write your description files
  • tables # A map: keys are schemas in your database (at a minimum you probably want public), and values are lists of table names within that schema