Teradata MultiLoad/Notify Exit Routine Interface - MultiLoad

Teradata® MultiLoad Reference - 20.00

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
Lake
VMware
Product
MultiLoad
Release Number
20.00
Published
October 2023
Language
English (United States)
Last Update
2024-03-18
dita:mapPath
lji1691576359330.ditamap
dita:ditavalPath
kju1619195148891.ditaval
dita:id
sga1478609868891
Product Category
Teradata Tools and Utilities
Teradata MultiLoad accumulates operational information about specific events that occur during a Teradata MultiLoad job. If the BEGIN MLOAD command or the BEGIN DELETE MLOAD command includes a NOTIFY option with an EXIT specification, then, when the specific events occur, Teradata MultiLoad calls the named Notify Exit routine and passes to it:
  • An event code to identify the event
  • Specific information about the event

The following table lists the event codes and describes the data that Teradata MultiLoad passes to the Notify Exit routine for each event. For a description of the events associated with each level of notification (low, medium, and high), see the description of the NOTIFY command option for BEGIN MLOAD and BEGIN DELETE MLOAD.

  • To support future enhancements, always make sure that Notify Exit routines ignore invalid or undefined event codes, and that they do not cause Teradata MultiLoad to terminate abnormally.
  • The database name is displayed in NFYEXIT.OUT as part of notification information.
Events Passed to the Notify Exit Routines 
Event Code Event Event Description Data Passed to the Notify Exit Routine
0 Initialize Successful processing of the NOTIFY option of the BEGIN MLOAD or BEGIN DELETE MLOAD 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—32-byte (maximum) array
  • User name length—4-byte unsigned integer
  • User name string—64-byte (maximum) array
  • Optional string length—4-byte unsigned integer
  • Optional string—80-byte (maximum) array
1 File or INMOD open Successful processing of the IMPORT command that specifies the file or INMOD routine name
  • File name length—4-byte unsigned integer
  • File name—256-byte (maximum) array
  • Import number—4-byte unsigned integer
2 Phase 1 begin The beginning of the acquisition phase

It is called one time for each table specified in the BEGIN MLOAD or BEGIN DELETE MLOADcommands.

  • Table name length—4-byte unsigned integer
  • Table name—128-byte (maximum) array
  • Table number—4-byte unsigned integer
  • DBaseName—62-byte array
3 Checkpoint Checkpoint information has been written to the restart log table. Record number—4-byte unsigned integer
4 Phase 1 end The CHECKPOINT LOADING END request has successfully completed after the end of the acquisition phase.
  • Records read—4-byte unsigned integer
  • Records skipped—4-byte unsigned integer
  • Records rejected—4-byte unsigned integer
  • Records sent to the database—4-byte unsigned integer
5 Phase 2 begin The EXEC MLOAD request is about to be sent to the database. No data accompanies the phase 2 begin event code
6 Phase 2 end Processing of the EXEC MLOAD request completed successfully.
  • Records inserted—4-byte unsigned integer
  • Records updated—4-byte unsigned integer
  • Records deleted—4-byte unsigned integer
  • Table number—4-byte unsigned integer
7 Error table 1 Processing of the SEL COUNT(*) request completed successfully for the first error table.
  • Number of rows—4-byte unsigned integer
  • Table number—4-byte unsigned integer
8 Error table 2 Processing of the SEL COUNT(*) request completed successfully for the second error table.
  • Number of rows—4-byte unsigned integer
  • Table number—4-byte unsigned integer
9 Database restart Teradata MultiLoad received a crash message from the database or from the CLIv2. No data accompanies the database restart event code
10 CLIv2 error Teradata MultiLoad received a CLIv2 error. Error code—4-byte unsigned integer
11 Database error Teradata MultiLoad received a database error that will produce an exit code of 12. Error code—4-byte unsigned integer
Not all database errors cause this event. For example, an Error 3807 while trying to drop or create a table does not terminate Teradata MultiLoad.
12 Exit Teradata MultiLoad is terminating. Exit code—4-byte unsigned integer
21 AMPs down The database has one or more down AMPs, just prior to the EXEC MLOAD statement. No data accompanies the AMPs down event code
22 Import begin The first record is about to be read for each import task. Import number—4-byte unsigned integer
23 Import end The last record has been read for each import task. The returned data is the record statistics for the import task.
  • Records read—4-byte unsigned integer
  • Records skipped—4-byte unsigned integer
  • Records rejected—4-byte unsigned integer
  • Records sent to the database—4-byte unsigned integer
  • Import number—4-byte unsigned integer
24 Delete init. Successful processing of a BEGIN DELETE MLOAD 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—32-byte (maximum) array
  • User name length—4-byte unsigned integer
  • User name string—64-byte (maximum) array
  • Optional string length—4-byte unsigned integer
  • Optional string—80-byte (maximum) array
25 Delete begin A DELETE statement is about to be sent to the database.
  • Table name length—4-byte unsigned integer
  • Table name—128-byte (maximum) array
  • Table number—4-byte unsigned integer
  • DBaseName—string holds maximum supported length of a database object
26 Delete end Successful processing of the EXEC MLOAD request for a delete task
  • Records deleted—4-byte unsigned integer
  • Table number—4-byte unsigned integer
27 Delete exit The end of a delete task Exit code—4-byte unsigned integer
28 Phase 1 end 64 The CHECKPOINT LOADING END request has successfully completed after the end of the acquisition phase.
  • Records read—24-byte string
  • Records skipped—24-byte string
  • Records rejected—24-byte string
  • Records sent to the database—24-byte string
29 Import end 64 The last record has been read for each import task. The returned data is the record statistics for the import task.
  • Records read—24-byte string
  • Records skipped—24-byte string
  • Records rejected—24-byte string
  • Records sent to the database—24-byte string
  • Import number—4-byte unsigned integer
30 Initialize EON Successful processing of the NOTIFY option of the BEGIN MLOAD or BEGIN DELETE MLOAD 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—32-byte (maximum) array
  • User name length—4-byte unsigned integer
  • User name string—string holds maximum supported length of a database object
  • User string length—4-byte unsigned integer
  • User string—string holds maximum supported length of a database object
31 Phase 1 begin EON The beginning of the acquisition phase

It is called one time for each table specified in the BEGIN MLOAD or BEGIN DELETE.

  • Table name length—4-byte unsigned integer
  • Table name—string holds maximum supported length of a database object
  • Table number—4-byte unsigned integer
  • DBaseName—string holds maximum supported length of a database object
32 Checkpoint 64 Checkpoint information has been written to the restart log table Record number—24-byte string
33 Phase 2 end 64 Processing of the EXEC MLOAD request completed successfully.
  • Records inserted—24-byte string
  • Records updated—24-byte string
  • Records deleted—24-byte string
  • Table number—4-byte unsigned integer
34 Error table 1 64 Processing of the SEL COUNT(*) request completed successfully for the second error table.
  • Number of rows—24-byte string
  • Table number—4-byte unsigned integer
35 Error table 2 64 Processing of the SEL COUNT(*) request completed successfully for the second error table

For each table specified in the BEGIN MLOAD command:

  • Number of rows—24-byte string
  • Table number—4-byte unsigned integer
36 Delete init. EON Successful processing of a BEGINDELETE MLOAD 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—32-byte (maximum) array
  • User name length—4-byte unsigned integer
  • User name string—string holds maximum supported length of a database object
  • User string length—4-byte unsigned integer
  • User string—string holds maximum supported length of a database object
37 Delete begin EON A DELETE statement is about to be sent to the database.
  • Table name length—4-byte unsigned integer
  • Table name—string holds maximum supported length of a database object
  • Table number—4-byte unsigned integer
  • DBaseName—string holds maximum supported length of a database object
38 Delete end 64 Successful processing of the EXEC MLOAD request for a delete task
  • Records deleted—24-byte string
  • Table number—4-byte unsigned integer