Functions / System Information Functions And Operators

shobj_description

Returns the comment for a shared database object specified by its OID and the name of the containing system catalog.

Reading PG 18current·documented in 21 of 27 versions, 8.2 to 20

7.1 7.2 7.3 7.4 8.0 8.1 8.2 8.3 8.4 9.0 9.1 9.2 9.3 9.4 9.5 9.6 10 11 12 13 14 15 16 17 18 19 20

Signatures & examples

shobj_description ( object oid, catalog name ) → text

Returns the comment for a shared database object specified by its OID and the name of the containing system catalog. This is just like obj_description except that it is used for retrieving comments on shared objects (that is, databases, roles, and tablespaces). Some system catalogs are global to all databases within each cluster, and the descriptions for objects in them are stored globally as well.

Version history 2

12 → 13 changed
8.1 → 8.2 added

Definition snapshot: b7bd9cda · English manual source