Message-ID: <47CDB71D.3000106@avature.net>
Date: Tue, 04 Mar 2008 18:54:53 -0200
From: =?UTF-8?B?VG9tw6FzIERpIERvbcOpbmljbw==?= <tdidomenico@avature.net>
User-Agent: Mozilla-Thunderbird 2.0.0.9 (X11/20080110)
MIME-Version: 1.0
To: Shahaf Abileah <shahaf@redfin.com>, pgsql-general@postgresql.org
Subject: Re: Documenting a DB schema
References: <082D8A131DF72A4D88C908A1AD3DEB22023B34F2@mail-1.rf.lan>
In-Reply-To: <082D8A131DF72A4D88C908A1AD3DEB22023B34F2@mail-1.rf.lan>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: quoted-printable

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

Cheers!

Shahaf Abileah wrote:
> I=E2=80=99m 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?
>=20
> =20
>=20
> It would be great if the documentation could be kept as close to the
> code as possible =E2=80=93 that way we stand a chance of keeping it up =
to date.=20
> So, in the same way that Java docs go right there on top of the class o=
r
> 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:
>=20
> =20
>=20
>             create table table_with_comments(a int comment 'this is
> column a...');
>=20
> =20
>=20
> (see http://dev.mysql.com/doc/refman/5.0/en/create-table.html)
>=20
> =20
>=20
> However, Postgres doesn=E2=80=99t support the =E2=80=9Ccomment=E2=80=9D=
 keyword.  Is there an
> alternative?
>=20
> =20
>=20
> Thanks,
>=20
> =20
>=20
> --S
>=20
> =20
>=20
> *Shahaf Abileah *|* Lead Software Developer *
>=20
> shahaf@redfin.com | tel: 206.859.2869 | fax: 877.733.3469
>=20
> Redfin Corporation
> 710 2nd Ave
> Suite 600
> Seattle, WA 98104
>=20
> =20
>=20