Help Center > > Developer Guide> System Catalogs and System Views> System Catalogs> PG_SHDESCRIPTION

PG_SHDESCRIPTION

Updated at:Jul 15, 2020 GMT+08:00

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

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

Unlike most system catalogs, PG_SHDESCRIPTION is shared across all databases of a cluster. There is only one copy of PG_SHDESCRIPTION per cluster, not one per database.

Table 1 PG_SHDESCRIPTION columns

Name

Type

Reference

Description

objoid

oid

Any OID column

OID of the object this description pertains to

classoid

oid

PG_CLASS.oid

OID of the system catalog this object appears in

description

text

-

Arbitrary text that serves as the description of this object

Did you find this page helpful?

Submit successfully!

Thank you for your feedback. Your feedback helps make our documentation better.

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel