]> begriffs open source - ai-pg/blob - full-docs/txt/catalog-pg-shdescription.txt
Convert HTML docs to more streamlined TXT
[ai-pg] / full-docs / txt / catalog-pg-shdescription.txt
1
2 52.49. pg_shdescription #
3
4    The catalog pg_shdescription stores optional descriptions (comments)
5    for shared database objects. Descriptions can be manipulated with the
6    COMMENT command and viewed with psql's \d commands.
7
8    See also pg_description, which performs a similar function for
9    descriptions involving objects within a single database.
10
11    Unlike most system catalogs, pg_shdescription is shared across all
12    databases of a cluster: there is only one copy of pg_shdescription per
13    cluster, not one per database.
14
15    Table 52.49. pg_shdescription Columns
16
17    Column Type
18
19    Description
20
21    objoid oid (references any OID column)
22
23    The OID of the object this description pertains to
24
25    classoid oid (references pg_class.oid)
26
27    The OID of the system catalog this object appears in
28
29    description text
30
31    Arbitrary text that serves as the description of this object