CONNECTION_PROPERTY function [System]

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

Syntax
CONNECTION_PROPERTY( 
{ integer-expression-1 | string-expression }
[ , integer-expression-2 ] )
Parameters
  • integer-expression-1   In most cases it is more convenient to supply a string expression as the first argument. If you do supply an integer-expression, it is the connection property ID. You can determine this using the PROPERTY_NUMBER function.

  • string-expression   The connection property Name. Either the property ID or the property name must be specified.

    For a list of connection properties, see Connection properties.

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

Returns

VARCHAR

Remarks

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

See also
Standards and compatibility
  • SQL/2003   Vendor extension.

Example

The following statement returns the number of prepared statements being maintained.

SELECT CONNECTION_PROPERTY( 'PrepStmt' );