From: Fabien COELHO <coelho@cri.ensmp.fr>
To: Tom Lane <tgl@sss.pgh.pa.us>
Cc: pgsql-docs@lists.postgresql.org, PostgreSQL Developers <pgsql-hackers@lists.postgresql.org>
Subject: Re: Another modest proposal for docs formatting: catalog descriptions
Date: Tue, 5 May 2020 07:52:08 +0200 (CEST)
Message-ID: <alpine.DEB.2.22.394.2005050743340.175044@pseudo> (raw)
In-Reply-To: <12984.1588643549@sss.pgh.pa.us>
References: <12984.1588643549@sss.pgh.pa.us>
Hello Tom,
> oid oid
> Row identifier
>
> adrelid oid (references pg_class.oid)
> The table this column belongs to
>
> adnum int2 (references pg_attribute.attnum)
> The number of the column
>
> adbin pg_node_tree
> The column default value, in nodeToString() representation. Use
> pg_get_expr(adbin, adrelid) to convert it to an SQL expression.
>
> Thoughts?
+1
My 0.02€: I'm wondering whether the description could/should match SQL
syntax, eg:
oid OID
adrelid OID REFERENCES pg_class(oid)
adnum INT2 REFERENCES pg_attribute(attnum)
…
Or maybe just uppercase type names, especially when repeated?
oid OID
adrelid OID (references pg_class.oid)
adnum INT2 (references pg_attribute.attnum)
…
I guess that reference targets would still be navigable.
--
Fabien.
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-docs@postgresql.org
Cc: coelho@cri.ensmp.fr, tgl@sss.pgh.pa.us, pgsql-hackers@lists.postgresql.org
Subject: Re: Another modest proposal for docs formatting: catalog descriptions
In-Reply-To: <alpine.DEB.2.22.394.2005050743340.175044@pseudo>
* 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