Thread: how to document database

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.

Thanks

--
Non c'è più forza nella normalità, c'è solo monotonia.

Kaloyan Iliev wrote:
> Hi,
>
> I'm using postgresql_autodoc. It is perfect for me. And if you have
> comments in the database the created document is like real documentation:-)

I can't make it work. I'm running Debian etch, and I always get

bott@banach:/tmp$ postgresql_autodoc -d tost
Can't call method "finish" on an undefined value at
/usr/bin/postgresql_autodoc line 1203.
bott@banach:/tmp$ man postgresql_autodoc

do you know what's wrong with it?

And how do you document the stored procedures? can you have something
similar to doxygen with postgresql_autodoc?

--
Non c'è più forza nella normalità, c'è solo monotonia.

Hi,

I am not familiar with doxygen, so I can't give you any advice. To me postgresql_autodoc -d <dbname> works perfectly.
I am useing version 1.25 of postgresql_autodoc.

I recevice documentation of the sotred rocedures when I have comments on them. Then when  
postgresql_autodoc generate HTML documentation the comments are there. That's it. 
I am sorry if this doesn't help you much.

Have a nice day,

Kaloyan Iliev

Ottavio Campana wrote:

Kaloyan Iliev wrote: 

Hi,

I'm using postgresql_autodoc. It is perfect for me. And if you have
comments in the database the created document is like real documentation:-)   

I can't make it work. I'm running Debian etch, and I always get

bott@banach:/tmp$ postgresql_autodoc -d tost
Can't call method "finish" on an undefined value at
/usr/bin/postgresql_autodoc line 1203.
bott@banach:/tmp$ man postgresql_autodoc

do you know what's wrong with it?

And how do you document the stored procedures? can you have something
similar to doxygen with postgresql_autodoc?
 

Kaloyan Iliev ha scritto:
> Hi,
>
> I am not familiar with doxygen, so I can't give you any advice. To me
> postgresql_autodoc -d <dbname> works perfectly.
> I am useing version 1.25 of postgresql_autodoc.
>
> I recevice documentation of the sotred rocedures when I have comments on them. Then when
> postgresql_autodoc generate HTML documentation the comments are there. That's it.
> I am sorry if this doesn't help you much.

so that must be a debian's bug. I'll work on it.

--
Non c'è più forza nella normalità, c'è solo monotonia.

On 4/7/06, Ottavio Campana <ottavio@campana.vi.it> wrote:
> I need to document the  database I develop so that other people can
> easily understand how it works.

Another tool to do this is the EMS postgresql manager.  It is not a
free tool but it produces absolutely gorgeous html documentation.  The
windows version also has a pl/pgsql debugger, which is kind of unique.

Merlin

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
--------------------------------------------------------------------