47.41. pg_shdescription

Note: The following description applies both to Postgres-XC and PostgreSQL if not described explicitly. You can read PostgreSQL as Postgres-XC except for version number, which is specific to each product.

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 47-41. pg_shdescription Columns

NameTypeReferencesDescription
objoidoidany OID columnThe OID of the object this description pertains to
classoidoidpg_class.oidThe OID of the system catalog this object appears in
descriptiontext Arbitrary text that serves as the description of this object