Re: How to make a good documentation of a database ? - Mailing list pgsql-general

From George Essig
Subject Re: How to make a good documentation of a database ?
Date
Msg-id 20041118175818.44700.qmail@web53709.mail.yahoo.com
Whole thread Raw
In response to How to make a good documentation of a database ?  (David Pradier <dpradier@apartia.fr>)
Responses Re: How to make a good documentation of a database ?
List pgsql-general
David Pradier wrote:
> The problem is, I don't want to use a lot of time to maintain this
> documentation, and above all, I'd prefer not to insert the information
> twice (read: a new constraint in the database should automagically
> update the documentation).

You could use the postgresql's comment statement together with postgresql_autodoc.  See the
following links for documentation and examples:

http://www.postgresql.org/docs/7.4/interactive/sql-comment.html
http://www.rbt.ca/autodoc/
http://www.rbt.ca/autodoc/output.html
http://www.rbt.ca/autodoc/autodocexample.html
http://www.rbt.ca/autodoc/output-graphviz.html

George Essig

pgsql-general by date:

Previous
From: Chris Browne
Date:
Subject: Re: How to make a good documentation of a database ?
Next
From: Patrick B Kelly
Date:
Subject: Re: Can COPY skip columns?