DB2 Version 9.7 for Linux, UNIX, and Windows
DB2 Version 9.7 for Linux, UNIX, and Windows
If you create a user exit program to automate log file archiving and retrieval, your user exit program passes return codes to the DB2® database manager that invoked the user exit program. The DB2 database manager can only handle a limited list of specific error codes. However, your user exit program might encounter many different kinds of error conditions, such as operating system errors. Your user exit program must map the error conditions it encounters to error codes that the database manager can handle.
Table 1 shows the codes that can be returned by a user exit program, and describes how these codes are interpreted by the database manager. If a return code is not listed in the table, it is treated as if its value were 32.
| Return Code | Explanation |
|---|---|
| 0 | Successful. |
| 4 | Temporary resource error encountered.a |
| 8 | Operator intervention is required.a |
| 12 | Hardware error.b |
| 16 | Error with the user exit program or a software function used by the program.b |
| 20 | Error with one or more of the parameters passed to the user exit program. Verify that the user exit program is correctly processing the specified parameters.b |
| 24 | The user exit program was not found. b |
| 28 | Error caused by an input/output (I/O) failure, or by the operating system.b |
| 32 | The user exit program was terminated by the user.b |
| 255 | Error caused by the user exit program not being able to load the library file for the executable.c |
| a For archiving or retrieval requests, a return code of 4 or 8 causes a retry in five minutes. If the user exit program continues to return 4 or 8 on retrieve requests for the same log file, DB2 will continue to retry until successful. (This applies to rollforward operations, or calls to the db2ReadLog API, which is used by the replication utility.) b User exit requests are suspended for five minutes. During this time, all requests are ignored, including the request that caused the error condition. Following this five-minute suspension, the next request is processed. If this request is processed without error, processing of new user exit requests continues, and DB2 reissues the archive request that failed or was suspended previously. If a return code greater than 8 is generated during the retry, requests are suspended for an additional five minutes. The five-minute suspensions continue until the problem is corrected, or the database is stopped and restarted. Once all applications have disconnected from the database, DB2 issues an archive request for any log file that might not have been successfully archived previously. If the user exit program fails to archive log files, your disk might become filled with log files, and performance might be degraded. Once the disk becomes full, the database manager will not accept further application requests for database updates. If the user exit program was called to retrieve log files, rollforward recovery is suspended, but not stopped, unless the ROLLFORWARD STOP option was specified. If the STOP option was not specified, you can correct the problem and resume recovery. c If the user exit program returns error code 255, it is likely that the program cannot load the library file for the executable. To verify this, manually invoke the user exit program. More information is displayed. Note: During
archiving and retrieval operations, an alert message is issued for
all return codes except 0, and 4. The alert message contains the return
code from the user exit program, and a copy of the input parameters
that were provided to the user exit program.
|
|