Re: Documenting a DB schema

From: Tomás Di Doménico <tdidomenico(at)avature(dot)net>
To: Shahaf Abileah <shahaf(at)redfin(dot)com>, pgsql-general(at)postgresql(dot)org
Subject: Re: Documenting a DB schema
Date: 2008-03-04 20:54:53
Message-ID: 47CDB71D.3000106@avature.net
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-admin pgsql-docs pgsql-general pgsql-sql

Check http://www.postgresql.org/docs/8.3/interactive/sql-comment.html

Cheers!

Shahaf Abileah wrote:
> I’m looking for a systematic way to document the schema for the database
> behind our website (www.redfin.com <http://www.redfin.com/>), so that
> the developers using this database have a better idea what all the
> tables and columns mean and what data to expect. Any recommendations?
>
>
>
> It would be great if the documentation could be kept as close to the
> code as possible – that way we stand a chance of keeping it up to date.
> So, in the same way that Java docs go right there on top of the class or
> method definitions, it would be great if I could attach my comments to
> the table definitions. It looks like MySQL has that kind of capability:
>
>
>
> 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?
>
>
>
> Thanks,
>
>
>
> --S
>
>
>
> *Shahaf Abileah *|* Lead Software Developer *
>
> shahaf(at)redfin(dot)com | tel: 206.859.2869 | fax: 877.733.3469
>
> Redfin Corporation
> 710 2nd Ave
> Suite 600
> Seattle, WA 98104
>
>
>

In response to

Browse pgsql-admin by date

  From Date Subject
Next Message Michael Monnerie 2008-03-04 20:56:51 Re: Documenting a DB schema
Previous Message Emi Lu 2008-03-04 20:47:13 Re: Documenting a DB schema

Browse pgsql-docs by date

  From Date Subject
Next Message Michael Monnerie 2008-03-04 20:56:51 Re: Documenting a DB schema
Previous Message Emi Lu 2008-03-04 20:47:13 Re: Documenting a DB schema

Browse pgsql-general by date

  From Date Subject
Next Message Michael Monnerie 2008-03-04 20:56:51 Re: Documenting a DB schema
Previous Message Emi Lu 2008-03-04 20:47:13 Re: Documenting a DB schema

Browse pgsql-sql by date

  From Date Subject
Next Message Michael Monnerie 2008-03-04 20:56:51 Re: Documenting a DB schema
Previous Message Emi Lu 2008-03-04 20:47:13 Re: Documenting a DB schema