sa_conn_options system procedure

Returns property information for connection properties that correspond to database options.

Syntax

sa_conn_options( [ connidparm ] )

Parameters

connidparm
Use this optional INTEGER parameter to specify the connection ID number. The default is NULL.

Result set

Column name	Data type	Description
Number	INTEGER	Returns the connection ID (a number) for the current connection.
PropNum	INTEGER	Returns the connection property number.
OptionName	VARCHAR(255)	Returns the option name.
OptionDescription	VARCHAR(255)	Returns the option description.
Value	LONG VARCHAR	Returns the option value.

Remarks

Returns the connection ID as Number, and the PropNum, OptionName, OptionDescription, and Value for each available connection property that corresponds to a database option.

If connidparm is less than zero, then option values for the current connection are returned. If connidparm is not supplied or is NULL, then option values are returned for all connections to the current database provided that you have the required system privileges.

Privileges

You must have EXECUTE privilege on the system procedure.

To obtain the options for all connections, you must also have either the SERVER OPERATOR, MONITOR, or DROP CONNECTION system privilege. If you do not have one of these system privileges, then the results returned are for the current connection only.

Side effects

None

Example

The following example uses the sa_conn_options system procedure to display property information for connection properties that correspond to database options.

SELECT * FROM sa_conn_options()
    ORDER BY OptionName;

Number	PropNum	OptionName	OptionDescription	Value
1,952	502	blocking	Controls response to locking conflicts	On
1,952	503	blocking_timeout	Controls the time a transaction waits to obtain a lock	0
...	...	...	...	...