​
Overview

The shobj_description() is a comment information function that retrieves the comment associated with a shared database object.

​
Syntax

The syntax for the shobj_description() function is as follows: 
shobj_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 shared object for which you want to retrieve the comment
  • catalog_name: specifies the name of the system catalog that contains the shared object

​
Restrictions

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