Teradata TPump/Notify Exit Routine Interface
Teradata TPump accumulates operational information about specific events that occur during a Teradata TPump job. If the BEGIN LOAD command includes a NOTIFY option with an EXIT specification, then, when the specific events occur, Teradata TPump calls the named notify exit routine and passes to it:
Table 37 lists the event codes and describes the data that Teradata TPump passes to the notify exit routine for each event. (See the “BEGIN LOAD” command description in Chapter 3: “Teradata TPump Commands,” for a description of the events associated with each level of notification: low, medium, high, and ultra.)
Note: To support future enhancements, always make sure that the notify exit routines ignore invalid or undefined event codes, and that they do not cause Teradata TPump to terminate abnormally.
Event |
Event Code |
Event Description |
Data Passed to the Notify Exit Routine |
Initialize |
0 |
Successful processing of the NOTIFY option of the BEGIN LOAD command. |
|
InitializeEON |
0 |
Successful processing of the NOTIFY option of the BEGIN LOAD command. |
|
File or INMOD open |
1 |
Successful processing of the IMPORT command that specifies the file or INMOD routine name |
|
Checkpoint begin |
2 |
Teradata TPump is about to perform a checkpoint operation |
Record number – 4‑byte unsigned integer |
Import begin |
3 |
The first record is about to be read for each import task |
Import number – 4‑byte unsigned integer |
Import end |
4 |
The last record has been read for each import task. The returned data is the record statistics for the import task |
|
Error table |
5 |
Processing of the SEL COUNT(*) request completed successfully for the error table |
|
Teradata Database restart |
6 |
Teradata TPump received a crash message from Teradata Database or from the CLIv2 |
No data accompanies the Teradata Database restart event code |
CLIv2 error |
7 |
Teradata TPump received a CLIv2 error |
Error code – 4‑byte unsigned integer |
Teradata Database error |
8 |
Teradata TPump received a Teradata Database error that will produce an exit code of 12 |
Error code – 4‑byte unsigned integer Note: Not all Teradata Database errors cause this event. A 3807 error, for example, while trying to drop or create a table, does not terminate Teradata TPump. |
Exit |
9 |
Teradata TPump completed a load task |
Exit code – 4‑byte unsigned integer |
Table statistics |
10 |
Teradata TPump has successfully written the table statistics |
|
Checkpoint end |
11 |
Teradata TPump successfully completed the checkpoint operation |
Record number – 4‑byte unsigned integer |
Interim run statistics |
12 |
Teradata TPump is updating the Monitor Interface table, has just completed a checkpoint, or has read the last record for an import task. The returned data is the statistics for the current load |
|
DML error |
13 |
Teradata TPump received a Teradata Database error that was caused by DML and will introduce an error‑row insert to the error table |
“Feedback” always points to integer 0 when it is passed to the user exit routine. The user may change the value of this integer to 1 to instruct Teradata TPump not to log the error to the error table. In this case, Teradata TPump will not log the error, but continue other regular process on this error. |
Checkpoint begin 64 |
14 |
Teradata TPump is about to perform a checkpoint operation. |
Record number—8-byte unsigned integer |
Checkpoint end 64 |
15 |
Teradata TPump successfully completed the checkpoint operation |
Record number—8-byte unsigned integer |
Import end 64 |
16 |
The last record has been read for each import task. The returned data is the record statistics for the import task. |
|
Error table 64 |
17 |
Processing of the CAST(COUNT(*) AS BIGINT) request completed successfully for the error table. |
|
Table statistics 64 |
18 |
Teradata TPump has successfully written the table statistics. |
|
Interim run statistics 64 |
19 |
Teradata TPump is updating the Monitor Interface table, has just completed a checkpoint, or has read the last record for an import task. The returned data is the statistics for the current load. |
|
DML error 64 |
20 |
Teradata TPump received a Teradata Database error that was caused by DML and will introduce an error-row insert to the error table. |
|