Stream Operator Events - Parallel Transporter

Teradata Parallel Transporter Reference

Product
Parallel Transporter
Release Number
15.00
Language
English (United States)
Last Update
2018-09-27
dita:id
B035-2436
lifecycle
previous
Product Category
Teradata Tools and Utilities

Stream Operator Events

Table 47 lists the event codes and describes the data that the Stream operator passes to the notify exit routine or the system log.

Note: 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.

 

Table 47: Stream 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 option:

  • 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
  • Checkpoint Begin

    2

    Signifies that the Stream operator is about to perform a checkpoint operation

    Record number—4-byte unsigned integer

    Import Begin

    3

    Signifies that the first record is about to be read for each import task:

  • Import number—4-byte unsigned integer
  • Import End

    4

    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—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
  • Data Errors—4-byte unsigned integer.
  • Error Table

    5

    Signifies that processing of the SEL COUNT(*) request completed successfully for the error table:

  • Table Name—128-byte character (maximum) array.
  • Number of Rows—4-byte unsigned integer.
  • Teradata Database Restart

    6

    Signifies that the Stream operator received a crash message from the Teradata Database or from the CLIv2:

  • No data accompanies the Teradata Database restart event code
  • CLIv2 Error

    7

    Signifies that the Stream operator received a CLIv2 error:

  • Error code—4-byte unsigned integer
  • Teradata Database Error

    8

    Signifies that the Stream operator received a Teradata Database error that will produce an Exit code of 12:

  • Error code—4-byte 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 the Stream operator.

    Exit

    9

    Signifies that the Stream operator completed a load task:

  • Exit code—4-byte unsigned integer
  • Table Statistics

    10

    Signifies that the Stream operator has successfully written the table statistics:

  • Type (I = Insert, U = Update, D = Delete, or M = Merge) — 1-byte character variable.
  • Database Name — 64-character (maximum) array.
  • Table/Macro Name — 64-character (maximum) array
  • Activity count—4-byte unsigned integer
  • Checkpoint End

    11

    Signifies that the Stream operator has successfully completed the checkpoint operation:

  • Record number—4-byte unsigned integer
  • Interim Run Statistics

    12

    Signifies that the Stream operator is flushing the stale buffers (because a latency interval has expired), 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 the Teradata Database—4-byte unsigned integer
  • Requests sent to the Teradata Database—4-byte unsigned integer
  • 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
  • Data errors—4-byte unsigned integer
  • DML Error

    13

    Signifies that the Stream operator 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-character (maximum) array
  • Record number—4-byte unsigned integer
  • Data Input number—1-byte unsigned char
  • DML number—1-byte unsigned char
  • Statement number—1-byte unsigned char
  • Record data—6,004-character (maximum) array
  • Record data length—4-byte unsigned integer
  • Feedback—a pointer to 4-byte unsigned integer
  • “Feedback” always points to integer 0 when it is passed to the notify exit routine. You may change the value of this integer to 1 to instruct the Stream operator not to log the error to the error table. In this case, the Stream operator will not log the error, but will continue other regular processes on this error.

    Checkpoint Begin

    14

    Signifies that the Stream operator is about to perform a checkpoint operation:

  • Record number—8-byte unsigned integer
  • This event is only available when the value for the NotifyMethod attribute is set to 'Exit64' or 'ExitEON'.

    Checkpoint End

    15

    Signifies that the Stream operator has successfully completed the checkpoint operation:

  • Record number—8-byte unsigned integer
  • This event is only available when the value for the NotifyMethod attribute is set to 'Exit64' or 'ExitEON'.

    Error Table

    16

    Signifies that processing of the SEL CAST(COUNT(*) AS BIGINT) request completed successfully for the error table:

  • Table Name—128 byte character (maximum) array
  • 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'.

    Interim Run Statistics

    17

    Signifies that the Stream operator is flushing the stale buffers (because a latency interval has expired) and 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 the Teradata Database—8-byte unsigned integer
  • Requests sent to the Teradata Database—8-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
  • Data errors—8-byte unsigned integer
  • This event is only available when the value for the NotifyMethod attribute is set to'Exit64' or 'ExitEON'.

    Import End

    18

    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
  • Data Errors—8-byte unsigned integer.
  • This event is only available when the value for the NotifyMethod attribute is set to 'Exit64' or 'ExitEON'.

    Table Statistics

    19

    Signifies that the Stream operator has successfully written the table statistics:

  • Type (I = Insert, U = Update, D = Delete, or M = Merge) —
    1-byte character variable.
  • Database Name — pointer to a null-terminated string.
  • Table/Macro Name — pointer to a null-terminated string
  • Activity count—8-byte unsigned integer
  • This event is only available when the value for the NotifyMethod attribute is set to 'Exit64' or 'ExitEON'.

    Initialize

    20

    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'.

    Table 48 lists events that create notifications.

     

    Table 48: Stream Operator Events that Create Notifications 

    Event

    Notification Level

    Signifies

    Low

    Medium

    High

    Ultra

    Initialize

    Yes

    Yes

    Yes

    Yes

    Successful processing of the notify option)

    Checkpoint Begin

    No

    No

    Yes

    Yes

    Stream operator started a checkpoint

    Import Begin

    No

    No

    Yes

    Yes

    Stream operator is about to start reading records

    Import End

    No

    No

    Yes

    Yes

    Last record is read

    Error Table

    No

    No

    Yes

    Yes

    Successful processing of the SEL COUNT(*) request for the error table

    Teradata Database Restart

    No

    Yes

    Yes

    Yes

    Stream operator received a crash error from Teradata or CLI

    CLIv2 Error

    Yes

    Yes

    Yes

    Yes

    A CLIv2 error was encountered

    Teradata Database Error

    Yes

    Yes

    Yes

    Yes

    A crash error was encountered from the Teradata Database or CLIV2 that will terminate the load operation

    Exit

    Yes

    Yes

    Yes

    Yes

    Stream operator is terminating

    Table Statistics

    No

    Yes

    Yes

    Yes

    Stream operator has successfully written the table statistics

    Checkpoint End

    No

    No

    Yes

    Yes

    Stream operator successfully completed a checkpoint

    Interim Run Statistics

    No

    No

    No

    Yes

    Stream operator is about to flush the stale buffers (because a latency interval has expired), or Stream operator successfully completed a checkpoint, or an Import is just successfully completed

    DML Error

    No

    No

    Yes

    Yes

    Stream operator is about to log a DML error to the error table