Syntax - FastExport

Teradata® FastExport Reference

Product
FastExport
Release Number
17.00
Published
September 30, 2020
Language
English (United States)
Last Update
2020-09-02
dita:mapPath
ups1544831946863.ditamap
dita:ditavalPath
obe1474387269547.ditaval
dita:id
B035-2410
lifecycle
previous
Product Category
Teradata Tools and Utilities


where the following is true:

SESSIONS…
Maximum number of FastExport sessions that is logged on when a LOGON command is entered and, optionally, the minimum number of sessions required to run the job
  • The max value specifies the maximum number of sessions to log on. The max specification must be greater than zero. If a SESSIONS max value is specified that is larger than the number of available AMPs, FastExport limits the sessions to one per working AMP. The default maximum, if the SESSIONS option is not used, is 4.
  • The min value specifies the minimum number of sessions required for the job to continue. The min specification must be greater than zero. The default minimum, if the SESSIONS option is not used or a min value is specified, is 1. If the min value is specified as 0 which is invalid, FastExport will display an error message and terminate with the user error, RC=8"
  • The * value specifies the maximum and minimum number of sessions. Using the asterisk character as the max specification logs on for the maximum number of sessions, one for each AMP. Using the asterisk character as the min specification logs on for at least one session, but always less than or equal to the max specification.
For more information about setting number of sessions, see Usage Notes.
TENACITY hours
Number of hours that FastExport tries to log on to the database
When FastExport tries to log on for a new task, and the database indicates that the maximum number of utility import/export sessions are already running, FastExport:
  1. Waits for six minutes, by default, or for the amount of time specified by the SLEEP option.
  2. Then it tries to log on to the database again.
FastExport repeats this process until it has either logged on for the required number of sessions or exceeded the TENACITY hours time period.
The default value is 4.
For more information about the maximum number of load utility tasks that can run, see "Concurrent Load Utility Tasks" in Restrictions and Limitations.
For information on how the TENACITY command interacts with the SLEEP command, see the SLEEP minutes entry in this table.
SLEEP minutes
Number of minutes that FastExport waits between logon attempts
Default value is 6.
FastExport uses the SLEEP specification in conjunction with the TENACITY specification.
If the amount of time specified with the SLEEP command exceeds that of the TENACITY command, then the sleep interval is reset and equated to the amount of time specified by the TENACITY command.
For example, if the time specified with SLEEP command is 65 minutes and the time specified with TENACITY command is 1 hour, then the SLEEP time is reset to 60 minutes so that the SLEEP time does not exceed the TENACITY time.
The sleep interval specified by the SLEEP command is dynamically adjusted so that the total sleep time does not exceed the amount of time specified by the TENACITY command.
For example, if the time specified with the SLEEP command is 35 minutes and the time specified with the TENACITY command is 1 hour then:
FastExport sleeps for 35 minutes and then attempts to log on to the database.
  • If the first attempt fails, then the SLEEP time is dynamically adjusted to 25 minutes (SLEEP time subtracted from TENACITY time), so that the total SLEEP time does not exceed the TENACITY time (60 minutes).
NOTIFY…
FastExport 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 in this section.
  • NOTIFY MEDIUM enables the notify user exit option for those events signified by “Yes” in the Medium Notification Level column of the following table in this section.
  • NOTIFY HIGH enables the notify user exit option for those events signified by “Yes” in the High Notification Level column of the following table in this section.
EXIT name
User-defined exit where name is the name of a user-supplied library with a member name of _dynamn
The exit must be written in C, or in a programming language with a runtime environment that is compatible with C.
For an example, see "Sample Notify Exit Routine" in Generating Routines.
On some versions of UNIX operating systems, ./ prefix characters may have to be added to the EXIT name specification if the module is in the current directory.
A new EXIT64 keyword is added if the user intends to see large count values more than 4000, like 4294967300. It works the same way as EXIT keyword, and is used when the Notify value is higher than LOW.
EXITEON keyword is added if the user intends to view Extended Object Names of 128 characters. It works the same as EXIT keyword when Extended Object names are used in script.
TEXT 'string'
A user-supplied string of up to 80 characters that FastExport passes to the named user exit routine
The string specification must be enclosed in single quote characters (').
MSG 'string'
A user-supplied string of up to 16 characters that FastExport logs on to:
  • The operator’s console (mainframe-attached z/OS client systems)
  • The system log (workstation-attached UNIX and Windows client systems)
The string specification must be enclosed in single quote characters (').
QUEUE option
Queue management option on mainframe-attached z/OS client systems
This option is available only on z/OS, and only for tasks with a low notification specification.
This option invokes an ENQ when the BEGIN EXPORT command is processed, followed by a DEQ when the significant event occurs.
The option specification is one of the following:
RNAME
A parameter containing a quoted string of up to 255 characters.
The default is TDUSER.
SCOPE
A parameter that is one of the following:
JOB – Specifies that the QUEUE is local to the job, including all job steps.
SYSTEM – Specifies that the QUEUE is global to the computer running it.
SYSTEMS – Specifies that the QUEUE is global to all computers in the complex.
The default is SYSTEMS.
NOBLOCK
A parameter specifying that if the ENQ blocks for any reason, it must return an error instead. This is a fatal error for the job.
The default, an implied BLOCK (there is no BLOCK keyword), means that the ENQ will wait for the QUEUE.
DATAENCRYPTION
Keyword that enables data encryption for the FastExport job
Valid options are:
  • ON = All the requests between BEGIN EXPORT and END EXPORT commands will be encrypted.
  • OFF = The requests between BEGIN EXPORT and END EXPORT commands will not be encrypted. This is the default.
This option will apply only to the requests between BEGIN EXPORT and END EXPORT commands.
Using this option overwrites the data encryption settings specified by both the runtime parameters and in the fexpcfg.dat configuration file.
DECIMALDIGITS
A user-supplied maximum number of digits in the DECIMAL data type that can be exported. Starting from V2R6.2, the maximum number of digits in the DECIMAL data type increased from 18 to 38. Note that if a user does not set the limit, the default maximum number of digits is 18.
When the client is a mainframe, the user can set the limit to 31 to request automatic CAST to avoid n>31 results.
Using this option overwrites the max_decimal_returned value specified in the clispb.dat file for workstation-attached systems or the HSHSPB parameter for mainframe-attached systems.
NOSTOP
If the NOSTOP option is specified and the database or CLIv2 does not support Large Decimal, if the user specifies a valid value for the decimaldigits parameter, FastExport does the following:
  • Displays a message that the database or CLIv2 does not support Large Decimal
  • Displays a warning that the decimaldigits setting is ignored
  • Continues with the Teradata FastExport job
  • Exits with an exit code of 4, unless there is another error with a higher exit code
If the NOSTOP option is not specified and the database or CLIv2 does not support Large Decimal, if the user specifies a valid value for the decimaldigits parameter, FastExport maintains the current behavior and does the following:
  • Displays a message that the database or CLIv2 does not support Large Decimal
  • Terminates the FastExport job
  • Exits with an exit code of 8
If the user specifies a valid value for the max_decimal_returned parameter in clispb.dat, FastExport maintains the current behavior, regardless of NOSTOP option.
SPOOL
Tells FastExport to spool the answer set. This is the default.
NOSPOOL
Tells FastExport to try to use the NoSpool method. If the NoSpool method is not supported, FastExport issues a warning and then uses the Spool method
NOSPOOLONLY
Tells FastExport to use the NoSpool method only. If the NoSpool method is not supported, then terminate the job with an error.

The following table lists the events which create notifications.

Events that Create Notifications  
Event Notification Level Signifies
Low Medium High
Initialize Yes Yes Yes Successful processing of the BEGIN EXPORT command
File or INMOD open No No Yes Successful processing of the IMPORT command
Database Restart No Yes Yes A crash error from the database or CLIv2
CLIv2 error Yes Yes Yes A CLIv2 error
Database error Yes Yes Yes A database error that terminates FastLoad
Exit Yes Yes Yes FastExport is terminating
Export begin No Yes Yes Opening the export file
Request submit begin No Yes Yes Submitting the SELECT request
Request submit end No Yes Yes Received SELECT request response
Request fetch begin No Yes Yes Fetching SELECT request results
File or OUTMOD open No No Yes Opening output file or OUTMOD
Statement fetch begin No No Yes Fetching current statement
Statement fetch end No No Yes Last record fetched for current statement
Request fetch end No Yes Yes Last record fetched for current request
Export end No Yes Yes Export task completed
Block Count No Yes Yes The total number of blocks when the no spool is in effect