PROPERTY_DESCRIPTION function [System]

Function

Returns a description of a property.

Syntax

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

Parameters

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. For property names, see the lists in the sections “Connection properties”, “Properties available for the server”, and “Properties available for each database”.

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

See also

“Connection properties”

“Properties available for the server”

“Properties available for each database”