obj_description()

​

Overview

The obj_description() is a comment information function that returns the comment associated with a specific database object.

​

Syntax

The syntax for the obj_description() function is as follows:

obj_description (object_oid, catalog_name) → NULL

​

Parameters

The following parameters are required to execute this function:

• object_oid: specifies the object identifier (OID) of the database object for which you want to retrieve the comment
• catalog_name: specifies the name of the system catalog that contains the object

​

Restrictions

• This function always returns NULL if there are no parameters specified