SYSCS_UTIL.SYSCS_GET_XPLAIN_MODE system function

The SYSCS_UTIL.SYSCS_GET_XPLAIN_MODE function returns the current XPLAIN mode.

If the XPLAIN mode is non-zero, then statements are not actually executed, but are just compiled, and their statistics recorded in the SYSXPLAIN_* database tables. If the XPLAIN mode is zero (the default), then statements are executed normally.

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

Syntax

SYSCS_UTIL.SYSCS_GET_XPLAIN_MODE() RETURNS INTEGER

Execute privileges

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

Example

To determine the current value of the XPLAIN mode:

        values syscs_util.syscs_get_xplain_mode();