diff options
| author | Bruce Momjian <bruce@momjian.us> | 2006-02-12 03:22:21 +0000 |
|---|---|---|
| committer | Bruce Momjian <bruce@momjian.us> | 2006-02-12 03:22:21 +0000 |
| commit | f9a726aa883e1690f66bec535d85b34e1f9ed7e7 (patch) | |
| tree | 764d3d849a2614ea5edcd05eaa36496a79f06c87 /doc/src/sgml/func.sgml | |
| parent | 95dbf9c02f9a37fc171e0b94b37f9f903abc3942 (diff) | |
| download | postgresql-f9a726aa883e1690f66bec535d85b34e1f9ed7e7.tar.gz | |
I've created a new shared catalog table pg_shdescription to store
comments on cluster global objects like databases, tablespaces, and
roles.
It touches a lot of places, but not much in the way of big changes. The
only design decision I made was to duplicate the query and manipulation
functions rather than to try and have them handle both shared and local
comments. I believe this is simpler for the code and not an issue for
callers because they know what type of object they are dealing with.
This has resulted in a shobj_description function analagous to
obj_description and backend functions [Create/Delete]SharedComments
mirroring the existing [Create/Delete]Comments functions.
pg_shdescription.h goes into src/include/catalog/
Kris Jurka
Diffstat (limited to 'doc/src/sgml/func.sgml')
| -rw-r--r-- | doc/src/sgml/func.sgml | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index e2c27e1a35..addf2eeb05 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/func.sgml,v 1.304 2006/02/11 03:32:38 momjian Exp $ +$PostgreSQL: pgsql/doc/src/sgml/func.sgml,v 1.305 2006/02/12 03:22:16 momjian Exp $ PostgreSQL documentation --> @@ -9464,6 +9464,10 @@ SELECT pg_type_is_visible('myschema.widget'::regtype); </indexterm> <indexterm zone="functions-info"> + <primary>shobj_description</primary> + </indexterm> + + <indexterm zone="functions-info"> <primary>comment</primary> <secondary sortas="database objects">about database objects</secondary> </indexterm> @@ -9499,6 +9503,11 @@ SELECT pg_type_is_visible('myschema.widget'::regtype); <entry><type>text</type></entry> <entry>get comment for a table column</entry> </row> + <row> + <entry><literal><function>shobj_description</function>(<parameter>object_oid</parameter>, <parameter>catalog_name</parameter>)</literal></entry> + <entry><type>text</type></entry> + <entry>get comment for a shared database object</entry> + </row> </tbody> </tgroup> </table> @@ -9521,6 +9530,14 @@ SELECT pg_type_is_visible('myschema.widget'::regtype); <function>obj_description</function> cannot be used for table columns since columns do not have OIDs of their own. </para> + + <para> + <function>shobj_description</function> is used just like + <function>obj_description</function> only that it is used for retrieving + comments on shared objects. Some system catalogs are global to all + databases within each cluster and their descriptions are stored globally + as well. + </para> </sect1> <sect1 id="functions-admin"> |