PROPERTY_DESCRIPTION Function [System]

Returns a description of a property.

Syntax

PROPERTY_DESCRIPTION ( { property-id | property-name } )

Note: CIS functional compensation performance considerations apply.

Parameters

Parameter	Description
property-id	An integer that is the property number of the property. This number can be determined from the PROPERTY_NUMBER function. The `property-id` is commonly used when looping through a set of properties.
property-name	A string giving the name of the property.

Returns

VARCHAR

Example

The following statement returns the description “Number of index insertions:”

SELECT PROPERTY_DESCRIPTION( 'IndAdd' ) FROM iq_dummy

Usage

Each property has both a number and a name, but the number is subject to change between releases, and should not be used as a reliable identifier for a given property.

Standards and Compatibility

SQL—Vendor extension to ISO/ANSI SQL grammar.
Sybase—Not supported by Adaptive Server Enterprise.