Documentation Tools

From PostgreSQL wiki

Jump to: navigation, search

Tools that will provide documentation on an existing database, by reverse engineering the schema to generate diagrams or documents.

Many of the Design Tools can reverse engineer existing databases in addition to forward engineering.

Many PostgreSQL Clients have limited visualization features; this page is more for applications that focus on documentation.

SchemaSpy

http://schemaspy.sourceforge.net

Java, LGPL

SchemaSpy analyzes the metadata of a schema in a database and generates a visual representation of it in a browser-displayable format. It lets you click through the hierarchy of database tables via child and parent table relationships as represented by both HTML links and entity-relationship diagrams.

Autodoc

https://github.com/cbbrowne/autodoc

perl, open source

This is a utility which will run through PostgreSQL system tables and returns HTML, DOT, and several styles of XML which describe the database.

As a result, documentation about a project can be generated quickly and be automatically updatable, yet have a quite professional look if you do some DSSSL/CSS work.

SQLFairy

http://sqlfairy.sourceforge.net

Perl, manipulate structured data definitions (mostly database schemas) in interesting ways, such as converting among different dialects of CREATE syntax (e.g., MySQL-to-Oracle), visualizations of schemas (pseudo-ER diagrams: GraphViz or GD), automatic code generation (using Class::DBI), converting non-RDBMS files to SQL schemas (xSV text files, Excel spreadsheets), serializing parsed schemas (via Storable, YAML and XML), creating documentation (HTML and POD), and more.

Personal tools