Updated on 2024-05-07 GMT+08:00

PG_SHDESCRIPTION

PG_SHDESCRIPTION records optional comments for shared database objects. Descriptions can be manipulated with the COMMENT command and viewed with the \d command.

See also PG_DESCRIPTION, which provides a similar function for descriptions involving objects within a single database.

PG_SHDESCRIPTION is shared among all databases of a database instance. That is, there is only one PG_SHDESCRIPTION for each instance, not for each database.

Table 1 PG_SHDESCRIPTION columns

Name

Type

Reference

Description

objoid

oid

Any OID column

OID of the object that this description pertains to.

classoid

oid

oid in PG_CLASS

OID of the system catalog where the object appears.

description

text

-

Arbitrary text that serves as the description of the object.