Teradata FastLoad/NotifyExit Routine Interface | Teradata FastLoad - 17.10 - Teradata FastLoad/Notify Exit Routine Interface - FastLoad

Teradata® FastLoad Reference

Product
FastLoad
Release Number
17.10
Published
June 2021
Last Update
2021-07-01
Content Type
Programming Reference
Publication ID
B035-2411-061K
Language
English (United States)
Teradata FastLoad accumulates operational information about specific events that occur during a Teradata FastLoad job. If the Teradata FastLoad job script includes a NOTIFY command with an EXIT option specification, Teradata FastLoad calls the named Notify Exit routine and passes to it when the specific events occur:
  • An event code to identify the event
  • Specific information about the event

The table below lists the event codes and describes the data that Teradata FastLoad 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 NOTIFY.

  • User exits (INMOD and Notify Exit) should not make calls to the Teradata Call Level Interface (CLIv2). It can cause the normal operation of the utility to behave with unexpected results, and prevent requests from completing normally.
  • To support future enhancements, always ensure that Notify exit Routines ignore invalid or undefined event codes, and that they do not cause Teradata FastLoad to terminate abnormally.
  • Starting with Teradata Tools and Utilities 14.10, Teradata FastLoad supports 8-byte row counters. To display 8-byte counters in Notify events, use the new event with 64 as described in the following table and use the keyword EXIT64 rather than EXIT in the NOTIFY command.
  • Starting with Teradata Tools and Utilities 14.10, Teradata FastLoad supports the EON feature. To display large object names in Notify events, use the new event with EON as described in Table 18 and use the keyword EXITEON rather than EXIT in the NOTIFY command. The keyword EXITEON automatically supports the keyword EXIT64.
Events Passed to the Notify Exit Routine  
Event Code Event Event Description Data Passed to the Notify Exit Routine
0 Initialize Successful processing of the NOTIFY 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 DEFINE command that specifies the file or INMOD routine name.
  • File name length—4-byte unsigned integer
  • File name—256-byte (maximum) array
2 Phase 1 begin The beginning of the insert phase, where the table name is specified by the INSERT statement.
  • Table name length—4-byte unsigned integer
  • Table name—128-byte(maximum) array
  • Database name—62-byte (maximum) 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 insert 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 END LOADING command is about to be sent to the database. No data accompanies the phase 2 begin event code
6 Phase 2 end Processing of the END LOADING command completed successfully.
  • Records loaded—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
8 Error table 2 Processing of the SEL COUNT(*) request completed successfully for the second error table.
  • Number of rows—4-byte unsigned integer
9 Database restart Teradata FastLoad received a crash message from the database or from CLIv2. No data accompanies the database restart event code
10 CLIv2 error Teradata FastLoad received a CLIv2 error.
  • Error code—4-byte unsigned integer
11 Database error Teradata FastLoad received a database error that will produce an exit code of 12.
Not all database errors cause this event. An Error 3807, for example, while trying to drop or create a table does not terminate Teradata FastLoad.
  • Error code—4-byte unsigned integer
12 Exit FastLoad is terminating.
  • Exit code—4-byte unsigned integer
13 Check point 64 Checkpoint information has been written to the restart log table.
  • Record number—24-byte string written to the restart log table.
14 Phase I end 64 The CHECKPOINT LOADING END request has successfully completed after the end of the insert phase.
  • Records read—24-byte string
  • Records skipped—24-byte string
  • Records rejected—24-byte string
  • Records sent to the database—24-byte string
15 Phase 2 end 64 Processing of the END LOADING command completed successfully.
  • Records loaded—24-byte string
16 Error Table 1 64 Processing of the SEL COUNT(*) request completed successfully for the first error table.
  • Number of rows—24-byte string
17 Error Table 2 64 Processing of the SEL COUNT(*) request completed successfully for the second error table.
  • Number of rows—24-byte string
18 Initialize EON Successful processing of the NOTIFY 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—a byte pointer
  • Optional string length—4-byte unsigned integer
  • Optional string—80-byte (maximum) array
19 Phase 1 begin EON The beginning of the insert phase, where the table name is specified by the INSERT statement.
  • Table name length—4-byte unsigned integer
  • Table name—a character pointer
  • Database name—a character pointer