16.10 - Update Operator Events - Parallel Transporter

Teradata Parallel Transporter Reference

Product
Parallel Transporter
Release Number
16.10
Published
July 2017
Content Type
Programming Reference
Publication ID
B035-2436-077K
Language
English (United States)

The following table lists the event codes and describes the data that the Update operator passes to the notify exit routine for each event. The information in this table is also sent to the system log.

To support future enhancements, always verify that your notify exit routines ignore invalid or undefined event codes, and that they do not cause the operator to terminate abnormally.
Update Operator Notify Event Codes 
Event Event Code Event Description and Data Passed To The Notify Exit Routine
Initialize 0 Signifies successful processing of the notify feature:
  • Version ID length—4-byte unsigned integer
  • Version ID string—32-character (maximum) array
  • Operator ID—4-byte unsigned integer
  • Operator name length—4-byte unsigned integer
  • Operator name string—32-character (maximum) array
  • User name length—4-byte unsigned integer
  • User name string—64-character (maximum) array
  • Optional string length—4-byte unsigned integer
  • Optional string—80-character (maximum) array
  • Operator handle—4-byte unsigned integer
Phase 1 Begin 2 Signifies the beginning of the insert phase, where table name is specified by the DML statement:
  • Table name length—4-byte unsigned integer
  • Table name—128-character (maximum) array
  • Table number—4-byte unsigned integer
Checkpoint 3 Signifies that checkpoint information is written to the restart log table:
  • Record number—4-byte unsigned integer
Phase 1 End 4 Signifies 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 Teradata Database—4-byte unsigned integer
Phase 2 Begin 5 Signifies that the application phase is beginning:
  • No data accompanies the phase 2 begin event code
Phase 2 End 6 Signifies that the application phase is complete. For each table in the request:
  • Records inserted—4-byte unsigned integer
  • Records updated—4-byte unsigned integer
  • Records deleted—4-byte unsigned integer
  • Table number—4-byte unsigned integer
Error Table 1 7 Signifies that 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
Error Table 2 8 Signifies that 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
Teradata Database Restart 9 Signifies that the Update operator received a crash message from the Teradata Database or from the CLIv2:
  • No data accompanies the Teradata Database restart event code
CLIv2 Error 10 Signifies that the Update operator received a CLIv2 error:
  • Error code—4-byte unsigned integer
Teradata Database Error 11 Signifies that the Update operator received a Teradata Database error that will produce an Exit code of 12:
  • Error code—4-byte unsigned integer
Not all Teradata Database errors cause this event. A 3807 error, for example, while trying to drop or create a table does not terminate the Update operator.
Exit 12 Signifies that the Update operator is terminating:
  • Exit code—4-byte unsigned integer
AMPs Down 21 Signifies that the Teradata Database has one or more non-operational AMPs, just prior to the acquisition phase:
  • No data accompanies the AMPs Down event code
Import Begin 22 Signifies that the first record is about to be read for each import task:
  • Import number—4-byte unsigned integer
Import End 23 Signifies that the last record is 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 Teradata Database—4-byte unsigned integer
  • Import number—4-byte unsigned integer
Delete Init 24 Signifies successful processing of a DELETE statement:
  • No data accompanies the init. event code.
Delete Begin 25 Signifies that a DELETE statement is about to be sent to the Teradata Database:
  • Table name length—4-byte unsigned integer
  • Table name—128-character (maximum) array
  • Table number—4-byte unsigned integer
Delete End 26 Signifies successful processing of a delete task:
  • Records deleted—4-byte unsigned integer
  • Table number—4-byte unsigned integer
Delete Exit 27 Signifies the end of a delete task:
  • Exit code—4-byte unsigned integer
Checkpoint 28 Signifies that checkpoint information is written to the restart log table:
  • Record number—8-byte unsigned integer

This event is only available when the value for the NotifyMethod attribute is set to 'Exit64' or 'ExitEON'.

Phase I End 29 Signifies the CHECKPOINT LOADING END request has successfully completed after the end of the acquisition phase:
  • Records read—8-byte unsigned integer
  • Records skipped—8-byte unsigned integer
  • Records rejected—8-byte unsigned integer
  • Records sent to the Teradata Database—8-byte unsigned integer

This event is only available when the value for the NotifyMethod attribute is set to 'Exit64' or 'ExitEON'.

Import End 30 Signifies that the last record is 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 the Teradata Database—8-byte unsigned integer

This event is only available when the value for the NotifyMethod attribute is set to 'Exit64' or 'ExitEON'.

Phase 2 End 31 Signifies that the application phase is complete for each table in the request:
  • Table number—4-byte unsigned integer
  • Records inserted—8-byte unsigned integer
  • Records updated—8-byte unsigned integer
  • Records deleted—8-byte unsigned integer

This event is only available when the value for the NotifyMethod attribute is set to 'Exit64' or 'ExitEON'.

Error Table 1 32 Signifies that processing of the SEL CAST(COUNT(*) AS BIGINT) request completed successfully for the first error table:
  • Table number—4-byte unsigned integer
  • Number of rows—8-byte unsigned integer

This event is only available when the value for the NotifyMethod attribute is set to 'Exit64' or 'ExitEON'.

Error Table 2 33 Signifies that processing of the SEL CAST(COUNT(*) AS BIGINT) request completed successfully for the first error table:
  • Table number—4-byte unsigned integer
  • Number of rows—8-byte unsigned integer

This event is only available when the value for the NotifyMethod attribute is set to 'Exit64' or 'ExitEON'.

Initialize 34 Signifies successful processing of the notify feature:
  • Version ID length—4-byte unsigned integer
  • Version ID string—pointer to a null-terminated string
  • Operator ID—4-byte unsigned integer
  • Operator name length—4-byte unsigned integer
  • Operator name string—pointer to a null-terminated string
  • User name length—4-byte unsigned integer
  • User name string—pointer to a null-terminated string
  • Optional string length—4-byte unsigned integer
  • Optional string—pointer to a null-terminated string
  • Operator handle—4-byte unsigned integer

This event is only available when the value for the NotifyMethod attribute is set to 'ExitEON'.

Phase 1 Begin 35 Signifies the beginning of the insert phase, where table name is specified by the DML statement:
  • Table name length—4-byte unsigned integer
  • Table name—pointer to a null-terminated string
  • Table number—4-byte unsigned integer

This event is only available when the value for the NotifyMethod attribute is set to 'ExitEON'.

Delete Begin 36 Signifies that a DELETE statement is about to be sent to the Teradata Database:
  • Table name length—4-byte unsigned integer
  • Table name—pointer to a null-terminated string
  • Table number—4-byte unsigned integer

This event is only available when the value for the NotifyMethod attribute is set to 'ExitEON'.

The following table lists events that create notifications. Some events create notifications only for import tasks, some only for delete tasks, and some for both.

Update Operator Events That Create Notifications 
Event Import Task Delete Task Notification Level Signifies
Low Med High
Initialize x   Yes Yes Yes Successful processing of the notify option
Phase 1 Begin x   No Yes Yes The acquisition phase is beginning
Checkpoint x   No No Yes Checkpoint information is written to the restart log table
Phase 1 End x   No Yes Yes Successful completion of the acquisition phase
Phase 2 Begin x x No Yes Yes The application phase is beginning
Phase 2 End x   No Yes Yes Successful completion of the application phase
Error Table 1 x   No No Yes Successful processing of the SEL COUNT(*) request for the first error table
Error Table 2 x x No No Yes Successful processing of the SEL COUNT(*) request for the second error table
Teradata Database Restart x x No Yes Yes A crash error was encountered from the Teradata Database or CLIv2 that will terminate the load operation
CLIv2 Error x x Yes Yes Yes A CLIv2 error was encountered
Teradata Database Error x x Yes Yes Yes A Teradata Database error was encountered that will terminate the load operation
Exit x   Yes Yes Yes The Update operator is terminating
AMPs Down x x No No Yes Non-operational AMPs on the Teradata Database
Import Begin x   No No Yes First record about to be read
Import End x   No No Yes Last record is read
Delete Init   x Yes Yes Yes The delete task is about to begin
Delete Begin   x No Yes Yes DELETE statement about to be sent to the Teradata Database
Delete End   x No Yes Yes Successful delete task processing
Delete Exit   x Yes Yes Yes End of delete task