where the following is true:
- SESSIONS
- Keyword for the number of Teradata TPump sessions.
- number
- Number of sessions to be logged on for update purposes for Teradata TPump.
- threshold
- Minimum number of sessions to be logged on for update purposes for the utility.
- ERRORTABLE
- Optional keyword for identifying a database and error table.
- APPEND
- Specifies the existing error table.
- NODROP
- Specifies to retain (not DROP) the error table, even it is empty at the end of a job.
- QUEUETABLE
- Selects the error table as a Queue Table.
- dbname.
- The qualified database for the error table.
- tname
- Error table that receives information about errors detected during the load.
- ERRLIMIT
- Optional keyword for setting a limit on records rejected for errors.
- errcount
- Error threshold for controlling the number of rejected
records. Usage depends on whether used with the errpercent parameter.
- When used without the errpercent parameter, specifies, as an unsigned integer, the number of records that can be rejected and recorded in tname during a load (all records sent between the BEGIN LOAD and END LOAD commands). The default is no limit.
- When used with the errpercent parameter (which is approximate), specifies the maximum number of records that must be sent to the database before the errpercent parameter is applied.
- CHECKPOINT
- Keyword indicating the number of minutes between the occurrences of checkpoints.
- frequency
- The interval in minutes between check pointing operations. Specify an unsigned integer from 0 through 60, inclusive.
- DATA ENCRYPTION
- ON/OFF
- Keyword to encrypt import data and the request text during the communication between Teradata TPump and the database.
- ARRAY SUPPORT
- ON/OFF
- “ArraySupport ON|OFF” option to the .BEGIN LOAD command and the .DML command.
- TENACITY
- Keyword (with hours parameter) defining how long the utility tries to log on the sessions needed to perform the Teradata TPump job.
- hours
- Teradata TPump tenacity factor, as an integral number of hours. Specifies how long Teradata TPump keeps trying to logon to the required sessions.
- LATENCY
- Keyword for flushing stale buffers.When using the Teradata TPump latency option with Teradata Access Module for Named Pipes, need_full_block = no option should be added in the Named Pipes Access Module initialization string.
- seconds
- Flushing threshold based on number of seconds oldest record has resided in buffer.
- NOTIMERPROCESS
- Keyword to tell Teradata TPump not to fork a child process as a timer process.
- minutes
- Number of minutes to wait between unsuccessful logon attempts due to session limits errors on the database or CLIv2.
- SERIALIZE ON/OFF
- Keyword to set the state (ON/OFF) of the serialization feature which, if ON, guarantees that operations on a given key combination (row) occur serially.
- PACKMAXIMUM
- Keyword requesting Teradata TPump to dynamically determine the maximum possible PACK factor for the current load.
- PACK
- Keyword for the number of statements to pack into a multiple-statement request.
- statements
- Number of statements, as a positive integer of up to 1500, to pack into a multiple-statement request.
- RATE
- Keyword for entering the rate at which statements are sent to the database.
- RETRYTIMES nn
- Keyword for retry times number of retry times.
- statement_rate
- Initial maximum rate at which statements are sent to the database per minute.
- SLEEP
- Keyword for the number of minutes to sleep.
- NOATOMICUPSERT
- Keyword to perform non-atomic upsert operations for UPSERT DMLs in the job script if these UPSERT DMLs are not provided in the Atomic UPSERT form.
- NOMONITOR
- Keyword to prevent Teradata TPump from checking for statement rate changes from, or update status information for, the Teradata TPump Monitor.
- ROBUST ON/OFF
- The ON parameter ensures data integrity when target tables have identity columns.
- MACRODB
- Keyword for database to contain any macros used by Teradata TPump.
- dbname
- Name of database which is to contain any macros built/used by Teradata TPump.
- NOTIFY
- Teradata TPump implementation of the notify user exit
option:
- NOTIFY OFF suppresses the notify user exit option.
- NOTIFY LOW enables the notify user exit option for those events signified by “Yes” in the Low Notification Level column of the following table.
- NOTIFY MEDIUM enables the notify user exit option for the most significant events, as specified by “Yes” in the Medium Notification Level column of the following table.
- NOTIFY HIGH enables the notify user exit option for every Teradata TPump event that involves an operational decision point, as specified by “Yes” in the High Notification Level column of the following table.
- NOTIFY ULTRA enables the notify user exit option for every Teradata TPump event that involves an operational decision point, as specified by “Yes” in the ULTRA Notification Level column of the following table.
- Beginning with Teradata Tools and Utilities 14.00, TPump terminates with a fatal error if any of NOTIFY error conditions occur.
- EXIT name
- Keyword phrase that calls a user-defined exit where name is the name of a user-supplied library with a member name of _dynamn.
- TEXT 'string'
- User-supplied string of up to 80 characters that Teradata TPump passes to the named exit routine.
- MSG 'string'
- User-supplied string of up to 16 characters that Teradata
TPump logs to:
- The operator’s console for mainframe-attached z/OS client systems
- The system log for workstation-attached client systems for UNIX and Windows systems
- EXIT64 name
- Keyword phrase that calls a user-defined exit where name is the name of a user-supplied library with a member name of _dynamn.
- EXITON name
- Keyword phrase that calls a user-defined exit where name is the name of a user-supplied library with a member name of _dynamn.
The following table lists events that create notifications.
Notification Level | |||||
---|---|---|---|---|---|
Event | Low | Medium | High | Ultra | Signifies |
Checkpoint Begin | No | No | Yes | Yes | Teradata TPump started a checkpoint. |
Checkpoint End | No | No | Yes | Yes | Teradata TPump successfully completed a checkpoint. |
CLIv2 Error | Yes | Yes | Yes | Yes | Teradata TPump received a CLIv2 error. |
Database Error | Yes | Yes | Yes | Yes | A database error that terminates Teradata TPump. |
DML Error | No | No | Yes | Yes | Teradata TPump is about to log a DML error to the error table. |
Error Table | No | No | Yes | Yes | Successful processing of the SEL COUNT(*) request for the error table. |
Exit | Yes | Yes | Yes | Yes | Teradata TPump completed a load task. |
File or INMOD Open | No | No | Yes | Yes | Successful processing of the IMPORT command. |
Import Begin | No | No | Yes | Yes | Teradata TPump is about to start reading records. |
Import End | No | No | Yes | Yes | Last record has been read. |
Initialize | Yes | Yes | Yes | Yes | Successful processing of the Notify option (BEGIN LOAD command). |
InitializeEON | Yes | Yes | Yes | Yes | Successful processing of the Notify option (BEGIN LOAD command). |
Interim Run Statistics | No | No | No | Yes | Teradata TPump is about to update the Monitor Interface table, or Teradata TPump successfully completed a checkpoint, or an Import has just completed successfully. |
Table Statistics | No | Yes | Yes | Yes | Teradata TPump has successfully written the table statistics. |
Database Restart | No | No | No | Yes | Teradata TPump received a crash error from the database or CLIv2. |