select open change scope Open full search

PG.CENTER connects PostgreSQL documentation, reference, and ecosystem knowledge. Maintained by Pigsty.

Supported versions: Current (18) / 17 / 16 / 15 / 14
Development versions: 19 / devel
Unsupported versions: 13 / 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4 / 8.3 / 8.2
Historical version. PostgreSQL 11 reached end of support in November 2023. See the current version for supported releases.

52.48. pg_shdescription

The catalog pg_shdescription stores optional descriptions (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 52.48. pg_shdescription Columns

Name Type References Description
objoid oid any OID column The OID of the object this description pertains to
classoid oid pg_class.oid The OID of the system catalog this object appears in
description text   Arbitrary text that serves as the description of this object

Report a documentation issue

Read the upstream documentation. For corrections, first check the current version.