SYSCS_UTIL.SYSCS_GET_XPLAIN_SCHEMA system function

The SYSCS_UTIL.SYSCS_GET_XPLAIN_SCHEMA function returns the XPLAIN schema for the connection.

The default XPLAIN schema is empty, so if the XPLAIN style has not been set, the function returns the empty string. If the XPLAIN schema has been set using SYSCS_UTIL.SYSCS_SET_XPLAIN_SCHEMA, the function returns the XPLAIN schema that was set. If the XPLAIN schema is set to a non-empty value, and runtime statistics are being captured, then the runtime statistics will be stored into the SYSXPLAIN_* database tables in that schema for later analysis.

See "Working with RunTimeStatistics" in Tuning Derby for additional information.

Syntax

SYSCS_UTIL.SYSCS_GET_XPLAIN_SCHEMA () RETURNS VARCHAR

Execute privileges

If authentication and SQL authorization are both enabled, only the database owner has execute privileges on this function by default. See "Configuring user authentication" and "Configuring user authorization" in the Derby Security Guide for more information. The database owner can grant access to other users.

Example

To determine the current value of the XPLAIN schema:

        values syscs_util.syscs_get_xplain_schema();