Teradata Parallel Data Pump

Chapter 5: Using INMOD and Notify Exit Routines
Preparing the INMOD Program
• In the parms string that Teradata TPump passes to the INMOD routine, each comment is
replaced by a single blank character.
• In the parms string that Teradata TPump passes to the INMOD routine, each consecutive
sequence of whitespace characters, such as blank, tab, and so on, that appears outside of
delimited strings, is replaced by a single blank character.
• FDLINMOD is used for compatibility by pointing to a data structure that is the same for
FDL INMODs.
Preparing the INMOD Program
This section describes the protocol used between Teradata TPump and an INMOD written for
Teradata TPump. The protocols are applicable to all client platforms running Teradata
TPump. Considerations applicable exclusively to UNIX-based clients are contained in
“Programming INMODs for UNIX-based Clients” on page 218.
On entry to an INMOD user exit routine for Teradata TPump, the conventional parameter
register points to a parameter list of two 32-bit addresses. The first 32-bit address points to a
data structure containing the following fields:
• Return Code/Function Code, 4-byte integer.
• Length, 4-byte integer, Length of the data record.
• Data Record, Input data record buffer. The maximum length is:
• 31K or 31,744 bytes for Teradata for Windows
• 62K or 63,488 bytes for Teradata Database for UNIX
INMOD Input Values
Table 38 lists valid values of the Return Code/Function Code field and their meanings As
input to the INMOD routine, as input to the INMOD routine.
Table 38: INMOD Input Return Code Values
Code
Description
0 Request for INMOD to initialize and return first record.
1 Request for INMOD to return a record.
2 Request for INMOD to reposition to last checkpoint because of client restart. Repositioning
information, provided by the INMOD after a code 3, is read from the restart logtable and
returned to the INMOD in the buffer normally used for the data record.
3 Request for INMOD to take a checkpoint. In the buffer normally used to return data, the
INMOD should return any information (up to 100 bytes) that it may need to reposition to
this checkpoint. Teradata TPump then saves this information in its restart log table.
216 Teradata Parallel Data Pump Reference