Teradata FastExport/Notify Exit Routine Interface - FastExport

Teradata FastExport Reference

Product
FastExport
Release Number
15.00
Language
English (United States)
Last Update
2018-09-28
dita:id
B035-2410
lifecycle
previous
Product Category
Teradata Tools and Utilities

Teradata FastExport/Notify Exit Routine Interface

FastExport accumulates operational information about specific events that occur during a FastExport job. If the BEGIN EXPORT command includes a NOTIFY option with an EXIT specification, then, when the specific events occur, FastExport calls the named notify exit routine and passes to it:

  • An event code to identify the event
  • Specific information about the event
  • Table 21 lists the event codes and descriptions of the data that FastExport passes to the notify exit routine for each event. (For a description of the events associated with each level of notification, see “BEGIN EXPORT” on page 75.)

    Note: To support future enhancements, always ensure that notify exit routines ignore invalid or undefined event codes, and that they do not cause FastExport to terminate abnormally.

     

    Table 21: 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 option of the BEGIN EXPORT command

  • Version ID length – 4byte unsigned integer
  • Version ID string – 32byte (maximum) array
  • Utility ID – 4byte unsigned integer
  • Utility name length – 4byte unsigned integer
  • Utility name string – 32byte (maximum) array
  • User name length – 4byte unsigned integer
  • User name string – 64byte (maximum) array
  • Optional string length – 4byte unsigned integer
  • Optional string – 80byte (maximum) array
  • 1

    File or INMOD open

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

  • File name length – 4byte unsigned integer
  • File name – 256byte (maximum) array
  • Import number – 4byte unsigned integer
  • 9

    Teradata Database restart

    FastExport received a crash message from Teradata Database or from CLIv2

    No data accompanies the Teradata Database restart event code

    10

    CLIv2 error

    FastExport received a CLIv2 error

    Error code – 4byte unsigned integer

    11

    Teradata Database error

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

    Error code – 4byte unsigned integer

    Note: Not all Teradata Database errors cause this event. For example, an Error 3807 that occurs while trying to drop or create a table does not terminate FastExport.

    12

    Exit

    FastExport is terminating

    Exit code – 4byte unsigned integer

    31

    Export begin

    FastExport is about to begin the export task by opening the export file

    Database name – Database name - 62-byte (maximum) array

    32

    Request submit begin

    FastExport is about to submit the SELECT request to Teradata Database

  • Request length – 4byte unsigned integer
  • Request text – 32,000byte (maximum) array
  • 33

    Request submit end

    FastExport has received the response to the SELECT request

  • Statement count – 4byte unsigned integer
  • Block count – 4byte unsigned integer
  • 34

    Request fetch begin

    FastExport is about to fetch the results of the SELECT request

    No data accompanies the request fetch begin event code

    35

    File or OUTMOD open

    FastExport is about to open an output or OUTMOD routine file

  • File name length – 4byte unsigned integer
  • File name – 256byte (maximum) array
  • 36

    Statement fetch begin

    FastExport is about to fetch the current statement in a request

  • Statement number – 4byte unsigned integer
  • Block count – 4byte unsigned integer
  • 37

    Statement fetch end

    FastExport has fetched all of the records for the current statement

    Record count – 4byte unsigned integer

    38

    Request fetch end

    FastExport has fetched all of the records for the current request

  • Records exported – 4byte unsigned integer
  • Records rejected – 4byte unsigned integer
  • 39

    Export end

    FastExport has completed the export operation and displayed the number of exported records

  • Records exported – 4byte unsigned integer
  • Records rejected – 4byte unsigned integer
  • 40

    Block count

    FastExport has completed the export operation in NoSpool mode and displayed the total number of blocks.

    Block count – 4byte unsigned integer

    41

    Export end 64

    FastExport has completed the export operation and displayed the number of exported records

  • Records exported - 24-byte string
  • Records rejected – 4-byte unsigned integer
  •  

    42

    Initialize EON

    Successful processing of the NOTIFY option of the BEGIN EXPORT 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 – character string pointer
  • Optional string length – 4-byte unsigned integer
  • Optional string – 80-byte (maximum) array
  • 43

    Request submit begin EON

    FastExport is about to submit the SELECT request to Teradata Database

  • Request length – 4-byte unsigned integer
  • Request text – character string pointer
  • 44

    Export begin EON

    FastExport is about to begin the export task by opening the export file

    Database name – character string pointer