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@xxxxxxxxxx | tel: 206.859.2869 | fax: 877.733.3469
Redfin Corporation
710 2nd Ave
Suite 600
Seattle, WA 98104
Its probably best to try one list and see if you get a response rather
than sending the same message to 3 lists.
Comments are supported
CREATE TABLE follow_me_destination
(
mailbox_number character varying(10), -- Follow me users mailbox number.
destination_number character varying(32), -- Follow me phone number.
dest_id serial NOT NULL
)
WITHOUT OIDS;
ALTER TABLE follow_me_destination OWNER TO postgres;
COMMENT ON TABLE follow_me_destination IS 'Stores follow me numbers for
system users.';
COMMENT ON COLUMN follow_me_destination.mailbox_number IS 'Follow me
users mailbox number.';
COMMENT ON COLUMN follow_me_destination.destination_number IS 'Follow me
phone number.';
---------------------------(end of broadcast)---------------------------
TIP 4: Have you searched our list archives?
http://archives.postgresql.org/
