Re: how to document database

From: Aaron Bingham <bingham(at)cenix-bioscience(dot)com>
To: Ottavio Campana <ottavio(at)campana(dot)vi(dot)it>
Cc: pgsql-general(at)postgresql(dot)org
Subject: Re: how to document database
Date: 2006-04-10 09:04:53
Message-ID: 443A1FB5.2000600@cenix-bioscience.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-general

Ottavio Campana wrote:

>I need to document the database I develop so that other people can
>easily understand how it works.
>
>I particularly want to document the stored procedures. By now I've used
>a javadoc style to document them. I can't use tools like doxygen on them
>but it is always better than nothing.
>
>I'd like to know if you're using some particular tool.
>
Hi Ottavio,

Have you tried PostgreSQL Autodoc (http://www.rbt.ca/autodoc/)? It
generates HTML documentation (or other formats) directly from your
database. It will use the comments added to the DB with the 'comment
on' statement. It can also generate graphical representations of your
schema using various tools, including Graphviz.

Regards,

--
--------------------------------------------------------------------
Aaron Bingham
Senior Software Engineer
Cenix BioScience GmbH
Tatzberg 47 phone: +49 (351) 4173-146
D-01307 Dresden, Germany fax: +49 (351) 4173-198
--------------------------------------------------------------------

In response to

Browse pgsql-general by date

  From Date Subject
Next Message Martijn van Oosterhout 2006-04-10 10:00:11 Re: Debian package for freeradius_postgresql module
Previous Message Harald Armin Massa 2006-04-10 08:55:44 Re: Updating & inserting in one shot!