CONNECTION_PROPERTY function [System]

Function

Returns the value of a given connection property as a string.

Syntax

CONNECTION_PROPERTY ( { integer-expression1 | string-expression }
                                                     ... [ , integer-expression2 ] )

Parameters

integer-expression1 In most cases, it is more convenient to supply a string expression as the first argument. If you do supply integer-expression1, it is the connection property ID. You can determine this using the PROPERTY_NUMBER function.

string-expression The connection property name. You must specify either the property ID or the property name.

integer-expression2 The connection ID of the current database connection. The current connection is used if this argument is omitted.

Example

The following statement returns the number of prepared statements being maintained, for example, 4:

SELECT connection_property( 'PrepStmt' )FROM iq_dummy

Usage

The current connection is used if the second argument is omitted.

Standards and compatibility

See also

“Connection properties”

“PROPERTY_NUMBER function [System]”