Functions / System Information Functions And Operators

obj_description

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

Reading PG 18current·documented in 26 of 27 versions, 7.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

obj_description ( object oid, catalog name ) → text

Returns the comment for a database object specified by its OID and the name of the containing system catalog. For example, obj_description(123456, 'pg_class') would retrieve the comment for the table with OID 123456.

obj_description ( object oid ) → text

Returns the comment for a database object specified by its OID alone. This is deprecated since there is no guarantee that OIDs are unique across different system catalogs; therefore, the wrong comment might be returned.

Version history 4

12 → 13 changed
7.4 → 8.0 changed
7.3 → 7.4 changed
7.1 → 7.2 added

Definition snapshot: b7bd9cda · English manual source