DB2Explain CLI/ODBC configuration keyword

Determines whether Explain snapshot, Explain table, or both information will be generated by the server.

db2cli.ini keyword syntax:
DB2Explain = 0 | 1 | 2 | 3
Default setting:
Neither Explain snapshot nor Explain table information will be generated by the server.
Equivalent connection attribute:
SQL_ATTR_DB2EXPLAIN
Usage notes:
 
This keyword determines whether Explain snapshot, Explain table, or both information will be generated by the server.
  • 0 = both off (default)

    A 'SET CURRENT EXPLAIN SNAPSHOT=NO' and a 'SET CURRENT EXPLAIN MODE=NO' statement will be sent to the server to disable both the Explain snapshot and the Explain table information capture facilities.

  • 1 = Only Explain snapshot facility on

    A 'SET CURRENT EXPLAIN SNAPSHOT=YES' and a 'SET CURRENT EXPLAIN MODE=NO' statement will be sent to the server to enable the Explain snapshot facility, and disable the Explain table information capture facility.

  • 2 = Only Explain table information capture facility on

    A 'SET CURRENT EXPLAIN MODE=YES' and a 'SET CURRENT EXPLAIN SNAPSHOT=NO' will be sent to the server to enable the Explain table information capture facility and disable the Explain snapshot facility.

  • 3 = Both on

    A 'SET CURRENT EXPLAIN MODE=YES' and a 'SET CURRENT EXPLAIN SNAPSHOT=YES' will be sent to the server to enable both the Explain snapshot and the Explain table information capture facilities.

Explain information is inserted into Explain tables, which must be created before the Explain information can be generated. The current authorization ID must have INSERT privilege for the Explain tables.
Remarks
Db2® for z/OS® server supports only 0 (OFF) and 2 (Table) values in DB2Explain settings as only explain mode information is available. If the DB2Explain keyword is attempted to set against the data server which do not support it, the application receives an error "CLI0150E Driver not capable".