From: | aklaver(at)comcast(dot)net (Adrian Klaver) |
---|---|
To: | "Shahaf Abileah" <shahaf(at)redfin(dot)com>, <pgsql-general(at)postgresql(dot)org> |
Subject: | Re: [SQL] Documenting a DB schema |
Date: | 2008-03-04 20:42:34 |
Message-ID: | 030420082042.3229.47CDB43A000A6BA400000C9D22069997359D0A900E04050E@comcast.net |
Views: | Raw Message | Whole Thread | Download mbox | Resend email |
Thread: | |
Lists: | pgsql-general |
-------------- Original message ----------------------
From: "Shahaf Abileah" <shahaf(at)redfin(dot)com>
> 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
>
>
>
See:
http://www.postgresql.org/docs/8.2/interactive/sql-comment.html
--
Adrian Klaver
aklaver(at)comcast(dot)net
From | Date | Subject | |
---|---|---|---|
Next Message | Oisin Glynn | 2008-03-04 20:45:51 | Re: [GENERAL] Documenting a DB schema |
Previous Message | Kristina Yamamoto | 2008-03-04 20:20:47 | Question about PostgreSQL's bytea compatibility with MS Access as front-end |