15.00 - Teradata TPump/Notify Exit Routine Interface - Parallel Data Pump

Teradata Parallel Data Pump Reference

prodname
Parallel Data Pump
vrm_release
15.00
category
Programming Reference
featnum
B035-3021-034K

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 “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 length4byte unsigned integer
  • Version ID string32byte (maximum) array
  • Utility ID4byte unsigned integer
  • Utility name length4byte unsigned integer
  • Utility name string36character (maximum) array
  • User name length4byte unsigned integer
  • User name string64byte (maximum) array
  • Optional string length4byte unsigned integer
  • Optional string80byte (maximum) array
  • InitializeEON

    0

    Successful processing of the NOTIFY option of the BEGIN LOAD command.

  • Version ID length - 4-byte unsigned integer
  • Version ID string - 32-byte (maximum) array
  • Utility ID - 4-byte unsigned integer
  • Utility name length - 4-byte unsigned integer
  • Utility name string - 36-byte (maximum) array
  • User name length - 4-byte unsigned integer
  • User name string - holds maximum supported length of a database object
  • User string length - 4-byte unsigned integer
  • User string - holds maximum supported length of a database object
  • File or INMOD open

    1

    Successful processing of the IMPORT command that specifies the file or INMOD routine name

  • File name length4byte unsigned integer
  • File name256byte (maximum) array
  • Import number4byte unsigned integer
  • Checkpoint begin

    2

    Teradata TPump is about to perform a checkpoint operation

    Record number4byte unsigned integer

    Import begin

    3

    The first record is about to be read for each import task

    Import number4byte 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

  • Import number4byte unsigned integer
  • Records read4byte unsigned integer
  • Records skipped4byte unsigned integer
  • Records rejected4byte unsigned integer
  • Records sent to Teradata Database4byte unsigned integer
  • Data errors4byte unsigned integer
  • Error table

    5

    Processing of the SEL COUNT(*) request completed successfully for the error table

  • Table name128byte (maximum) array
  • Number of rows4byte unsigned integer
  • 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 code4byte unsigned integer

    Teradata Database error

    8

    Teradata TPump received a Teradata Database error that will produce an exit code of 12

    Error code4byte 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 code4byte unsigned integer

    Table statistics

    10

    Teradata TPump has successfully written the table statistics

  • Type (I = Insert, U = Update, or D = Delete) 1‑byte character variable
  • Database name64byte (maximum) array
  • Table/macro name64byte (maximum) array
  • Activity count4byte unsigned integer
  • Checkpoint end

    11

    Teradata TPump successfully completed the checkpoint operation

    Record number4byte 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

  • Import number4byte unsigned integer
  • Statements sent to Teradata Database4byte unsigned integer
  • Requests sent to Teradata Database4byte unsigned integer
  • Records read4byte unsigned integer
  • Records skipped4byte unsigned integer
  • Records rejected4byte unsigned integer
  • Records sent to Teradata Database4byte unsigned integer
  • Data errors4byte unsigned integer
  • DML error

    13

    Teradata TPump received a Teradata Database error that was caused by DML and will introduce an errorrow insert to the error table

  • Import number4byte unsigned integer
  • Error code4byte unsigned integer
  • Error message256character (maximum) array
  • Record number4byte unsigned integer
  • Apply number1byte unsigned char
  • DML number1byte unsigned char
  • Statement number1byte unsigned char
  • Record data64,004character (maximum) array
  • Record data length4byte unsigned integer
  • Feedbacka pointer to 4byte unsigned integer
  • “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.

  • Import number—4-byte unsigned integer
  • Records read—8-byte unsigned integer
  • Records skipped—8-byte unsigned integer
  • Records rejected—8-byte unsigned integer
  • Records sent to Teradata Database—8-byte unsigned integer
  • Data errors—8-byte unsigned integer
  • Error table 64

    17

    Processing of the CAST(COUNT(*) AS BIGINT) request completed successfully for the error table.

  • Table name—string holds maximum supported length of a database object
  • Number of rows—8-byte unsigned integer
  • Table statistics 64

    18

    Teradata TPump has successfully written the table statistics.

  • Type (I = Insert, U = Update, or D = Delete) — 1‑byte character variable
  • Database name—string holds maximum supported length of a database object
  • Table/macro name—string holds maximum supported length of a database object
  • Activity count—8-byte unsigned integer
  • 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.

  • Import number—4-byte unsigned integer
  • Statements sent to Teradata Database—4-byte unsigned integer
  • Requests sent to Teradata Database—4-byte unsigned integer
  • Records read—8-byte unsigned integer
  • Records skipped—8-byte unsigned integer
  • Records rejected—8-byte unsigned integer
  • Records sent to Teradata Database—8-byte unsigned integer
  • Data errors—8-byte unsigned integer
  • 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.

  • Import number—4-byte unsigned integer
  • Error code—4-byte unsigned integer
  • Error message—256-byte (maximum) array
  • Record number—8-byte unsigned integer
  • Apply number—1-byte unsigned char
  • DML number—1-byte unsigned char
  • Statement number—1-byte unsigned char
  • Record data—64,004-byte (maximum) array
  • Feedback—a pointer to 4-byte unsigned integer “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.