From: Shahaf Abileah <shahaf@redfin.com>
To: pgsql-admin@postgresql.org
To: pgsql-docs@postgresql.org
To: pgsql-general@postgresql.org
To: psql-novice@postgresql.org
To: pgsql-sql@postgresql.org
Subject: Documenting a DB schema
Date: Tue, 4 Mar 2008 12:02:27 -0800
Message-ID: <082D8A131DF72A4D88C908A1AD3DEB22023B34F2@mail-1.rf.lan> (raw)
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@redfin.com | tel: 206.859.2869 | fax: 877.733.3469
Redfin Corporation
710 2nd Ave
Suite 600
Seattle, WA 98104
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-sql@postgresql.org
Cc: shahaf@redfin.com, pgsql-admin@postgresql.org, pgsql-docs@postgresql.org, pgsql-general@postgresql.org, psql-novice@postgresql.org
Subject: Re: Documenting a DB schema
In-Reply-To: <082D8A131DF72A4D88C908A1AD3DEB22023B34F2@mail-1.rf.lan>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox