DB2ConnectionStringBuilder.db2dumpSQLCodes property

Specifies whether diagnostic logs are gathered when specified SQLCODEs are encountered in a connection to the Db2® for z/OS® server.

Namespace:
IBM.Data.DB2
Assembly:
IBM.Data.DB2 (in IBM.Data.DB2.dll)

Syntax


[Visual Basic]
Public Property db2dumpSQLCodes As String
[C#]
public String db2dumpSQLCodes {get; set;}
[C++]
public: __property String* db2dumpSQLCodes();
public: __property void db2dumpSQLCodes(String*);
[JScript]
public function get db2dumpSQLCodes() : String;
public function set db2dumpSQLCodes(String);

Property value

Set the db2dumpSQLCodes as follows:

  • OFF - No diagnostic information is logged. This is the default value.
  • DEFAULT - A special value that is equivalent to setting the following absolute SQLCODE values:
    • 30108 for the SQL30108N error
    • 20542 for the SQL20542N error
    • 1224 for the SQL1224N error
  • Absolute SQLCODE values - Absolute SQLCODE values that are separated by commas. Only the absolute SQLCODE values can be specified. For example, the following statement specifies SQL30108N and SQL20542N for the db2dumpSQLCodes keyword:
    Db2dumpSQLCodes = “30108,20542”;

Remarks

You can enable a mechanism to capture diagnostic information on the first occurrence of an SQL error event by using the db2dumpSQLCodes keyword during a connection to Db2 for z/OS. When you set the db2dumpSQLCodes keyword to a 'DEFAULT' or list of SQLCODEs, the following diagnostic information is written to a log file on the occurrence of a specified SQLCODE event:
  • Sysplex configuration information
  • Sysplex member statistics
  • Sysplex group statistics
  • Connection details that include the connection state and the process state
  • Client information properties that are explicitly set

Two rotating diagnostic log files that are 1 MB are generated per each application process. The name of the diagnostic log file consists of the db2dumpdata_<pid>.<index>.log format. The <pid> value in the log file name represents the process ID of the application and the <index> value represents a value that is equal or greater than 0. Once the log file reaches the size of 1 MB, the log file with the smallest index value is deleted, and new log file is created.

The diagnostic log files are placed in the clientrecords subdirectory under the diagnostic data directory path (diagpath).You must ensure that the diagnostic log files in the clientrecords subdirectory are deleted regularly to free up disk space on your system.

The db2dumpSQLCodes keyword setting takes effect only after the application is restarted.

Note: The default values of configuration parameters are not logged.

If db2dumpSQLCodes and cfgRefreshInterval keywords are also mentioned in db2dsdriver.cfg, once the time specified in cfgRefreshInterval is lapsed, the value of db2dumpSQLCodes specified in the db2dsdriver.cfg file will take precedence.