Teradata Parallel Data Pump

Chapter 5: Using INMOD and Notify Exit Routines
Overview
• Two-byte length specification, m
• The m-byte parms string, as parsed and presented by Teradata TPump
Caution:
To prevent data corruption, INMOD routines that cannot comply with these protocols should
terminate if they encounter a restart code 2, 3, or 4. To support proper Teradata TPump restart
operations, INMOD routines must save and restore checkpoint information as described here.
If the INMOD saves checkpoint information in some other manner, a subsequent restart/
recovery operation could result in data loss or corruption.
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:
• An event code to identify the event
• Specific information about the event
Table 37 lists the event codes and describes the data that Teradata TPump passes to the notify
exit routine for each event. (See the description of the NOTIFY option in 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.
Table 37: Events Passed to the Notify Exit Routine
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.
• Version ID length—4-byte unsigned integer
• Version ID string—32-character (maximum) array
• Utility ID—4-byte unsigned integer
• Utility name length—4-byte unsigned integer
• Utility name string—36-character (maximum)
array
• User name length—4-byte unsigned integer
• User name string—64-character (maximum) array
• Optional string length—4-byte unsigned integer
• Optional string—80-character (maximum) array
File or INMOD
open
1 Successful processing of the IMPORT
command that specifies the file or
INMOD routine name
• File name length—4-byte unsigned integer
• File name—256-character (maximum) array
• Import number—4-byte unsigned integer
Checkpoint begin 2 Teradata TPump is about to perform
a checkpoint operation
Record number—4-byte unsigned integer
208 Teradata Parallel Data Pump Reference