Re: Documenting a DB schema

From: Michael Monnerie <michael(dot)monnerie(at)it-management(dot)at>
To: pgsql-admin(at)postgresql(dot)org
Subject: Re: Documenting a DB schema
Date: 2008-03-04 20:56:51
Message-ID: 200803042156.51832@zmi.at
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-admin pgsql-docs pgsql-general pgsql-sql

On Dienstag, 4. März 2008 Shahaf Abileah wrote:
> create table table_with_comments(a int comment 'this is
> column a...');
> (see http://dev.mysql.com/doc/refman/5.0/en/create-table.html)
> However, Postgres doesn't support the "comment" keyword.  Is there an
> alternative?

This sounds nice at first thought... but: you need to document tables
also, and relations between tables etc. And especially the complex
dependencies can't be documented that way ("if you insert this here,
look into table x and y and compare this with table z, blabla").

And I'd like to know how often such funny documentation can be found
when it's used, take your example:
> create table table_with_comments(a int comment 'this is
> column a...');
I've seen such documentation a lot - just bought a Nokia E65 mobile
phone, it's handbook has this kind of documentation printed in it...
worthless.

But, BTW, does anybody have a good tool to show graphically the
relations between tables, and maybe even draw relations between tables
and create all necessary commands from this automatically? That would
be nice, along with documentation features...

mfg zmi
--
// Michael Monnerie, Ing.BSc ----- http://it-management.at
// Tel: 0676/846 914 666 .network.your.ideas.
// PGP Key: "curl -s http://zmi.at/zmi.asc | gpg --import"
// Fingerprint: AC19 F9D5 36ED CD8A EF38 500E CE14 91F7 1C12 09B4
// Keyserver: www.keyserver.net Key-ID: 1C1209B4

In response to

Responses

Browse pgsql-admin by date

  From Date Subject
Next Message Alan Hodgson 2008-03-04 21:00:50 Re: Documenting a DB schema
Previous Message Tomás Di Doménico 2008-03-04 20:54:53 Re: Documenting a DB schema

Browse pgsql-docs by date

  From Date Subject
Next Message Alan Hodgson 2008-03-04 21:00:50 Re: Documenting a DB schema
Previous Message Tomás Di Doménico 2008-03-04 20:54:53 Re: Documenting a DB schema

Browse pgsql-general by date

  From Date Subject
Next Message Alan Hodgson 2008-03-04 21:00:50 Re: Documenting a DB schema
Previous Message Tomás Di Doménico 2008-03-04 20:54:53 Re: Documenting a DB schema

Browse pgsql-sql by date

  From Date Subject
Next Message Alan Hodgson 2008-03-04 21:00:50 Re: Documenting a DB schema
Previous Message Tomás Di Doménico 2008-03-04 20:54:53 Re: Documenting a DB schema