Something like Sphinx but for SQL, so we could document table structures and relationships in a series of web pages.


A colleague mentioned PostgreSQL Autodoc

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.

It allows specifying schemas and tables, and can even process comments on objects in different markup languages (e.g. markdown) using specified translating executables.


A different colleague has recommended Amundsen as a more general purpose data documentation engine, which has a PostgreSQL metadata extractor:

Amundsen is a data discovery and metadata engine for improving the productivity of data analysts, data scientists and engineers when interacting with data. It does that today by indexing data resources (tables, dashboards, streams, etc.) and powering a page-rank style search based on usage patterns (e.g. highly queried tables show up earlier than less queried tables). Think of it as Google search for data.

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.