17.00 - INMOD Input Values - Parallel Data Pump

Teradata® Parallel Data Pump Reference

prodname
Parallel Data Pump
vrm_release
17.00
created_date
June 2020
category
Programming Reference
featnum
B035-3021-220K

The following table 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.

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.
4 Request for INMOD to reposition to last checkpoint because of a database failure. Repositioning information, provided by the INMOD after a code 3, is read from the restart log table and returned to the INMOD in the buffer normally used for the data record.
5 Request for INMOD to wrap up at termination.
6 Request for INMOD to initialize.
7 Request for INMOD to receive first (next) record.