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:

OUTFILE fileid
Data destination file on the client system.
The client system DD or equivalent statement specifies a file:
  • In UNIX OS and Windows, the fileid is the path name for a file.

    If the path name has embedded white space characters, the entire path name must be enclosed in single or double quotes.

    If the path name is enclosed by single quotation marks and there is an embedded single quotation mark, then an escape character (single quotation mark) needs to precede the embedded single quotation mark. Likewise, if the path name is enclosed by double quotation marks and there is an embedded double quotation mark, then an escape character (double quotation mark) needs to precede the embedded double quotation mark.

  • In z/OS, the fileid is a DDNAME.
AXSMOD name
Name of the access module file to be used to export data. These access modules include:
  • Teradata Access Module for OLE DB: oledb_axsmod.dll on Windows platforms
  • Teradata Access Module for JMS:
    • libjmsam.so on all supported UNIX platforms
    • libjmsam.dll on Windows platforms
A personal shared library file name can be used if a custom access module is used.
The AXSMOD option is not required for importing disk files on either workstation-attached or mainframe-attached client systems, or magnetic tape files on mainframe-attached client systems. It is required for importing magnetic tape and other types of files on workstation-attached client systems.
’init-string’
[Optional] initialization string for the access module
OUTMOD modulename
[Optional] user-written routine for processing the export data.
In z/OS, modulename is the name of a load module. On UNIX and Windows platforms, it is the path name of the OUTMOD executable code file.
FastExport provides six parameters to the named procedure, as described in FastExport/OUTMOD Routine Interface.
On some versions of UNIX operating systems, ./ prefix characters may have to be added to the OUTMOD modulename specification if the module is in the current directory.
MODE…
Format mode of the export data returned to the client system:
  • INDICATOR
  • RECORD
The default, if a MODE option is not specified, is INDICATOR mode.
FastExport does not support field mode. To export field mode data, use the appropriate format clauses in the SELECT statements to enable the database to convert response data to character format.
FORMAT...
Record format of the export file on workstation-attached systems where:
  • FASTLOAD specifies that each record is a two-byte integer, n, followed by n bytes of data, followed by an end-of-record marker, either X'0A' or X'0D'.
  • BINARY specifies that each record is a two-byte integer, n, followed by n bytes of data.
  • TEXT specifies that each record consists of an arbitrary number of characters in the client session character set, followed by an end-of-record marker, which is:
    • On UNIX platforms, the newline character (identified in Unicode as LINE FEED U+000A)
    • On Windows platforms, the two-character sequence carriage return followed by line feed (identified in Unicode as CARRIAGE RETURN U+000D and LINE FEED U+000A, respectively)
    For client session character sets other than UTF16, the end-of-record marker byte sequence is:
    • On UNIX platforms, X'0A'
    • On Windows platforms, X'0D0A'
    For the UTF16 client session character set (in which each character is encoded in two bytes), the end-of-record marker byte sequence is:
    • On big endian UNIX platforms, X'000A'
    • On little endian UNIX platforms, X'0A00'
    • On Windows platforms, X'0D000A00'
    TEXT format should only be specified for character data. Do not specify TEXT format for binary data, such as, INTEGER, BYTEINT, PERIOD, and other binary data. Depending on the actual byte values of the binary data, unexpected results may occur.
  • UNFORMAT specifies that each record is exported as it is received from CLIv2 without any client modifications.
The FORMAT options apply only to UNIX and Windows platforms.
The default, if a FORMAT option is not specified, is FASTLOAD.
  • INDICATOR mode is not recommended when using TEXT record format. Use UNFORMATTED record format instead.
  • TEXT data requires all CHAR or ANSIDATE data types.
BLOCKSIZE integer
Maximum block size that should be used when returning data to the client.

The default block size is 64K bytes. The maximum size is 64K.

The BLOCKSIZE specification for a FastExport EXPORT command cannot be larger than 64K because FastExport does not support 1MB Perm Rows.
OUTLIMIT records
Maximum number of response records that should be written to the output client file
When this number is reached, the utility writes the following message to the print output file and stops processing response data:
 Output limit of n exceeded.
MLSCRIPT fileid
Destination file of the generated MultiLoad script file
When the MLSCRIPT option is specified, FastExport generates a MultiLoad script file that can later be used to reload the export data back into the database.
The client system DD or equivalent statement specifies a file:
  • In UNIX OS and Windows, the fileid is the pathname for a file
  • In z/OS, the fileid is a DDNAME.
By default, if the MLSCRIPT option is not specified, then the FastExport utility does not generate a MultiLoad script file.
  • If the specified fileid already exists, it will be overwritten.
  • FastExport generates the MultiLoad script layout based on field sizes and types received from the database. Type DATE must be modified to CHAR () type as in the case of using ANSIDATE in the DATEFORM command. They must then be converted to the fixed length CHAR data type as though writing a script to load the data.
If Extended Object Name is used in Teradata FastExport, the resulting MultiLoad script file generated will not have column names in U& syntax. The user should add the U& syntax for the MultiLoad job to run successfully.
For example, Teradata FastExport uses a column as U&"c1#FF43#FF11"UESCAPE'#',
The resulting MultiLoad script is:
In order for Teradata MultiLoad to work properly, you must change c1c1 to U&"c1#FF43#FF11"UESCAPE'#'.
.LAYOUT DATAIN_LAYOUT INDICATORS;
.FIELD c1c1 1 INTEGER;
.FIELD c2 5 CHAR(20);

.DML LABEL INSERT_DML;
INSERT INTO &DBASE_TARGETTABLE..&TARGETTABLE (
 c1c1 = :c1c1
,c2 = :c2
);
PAD
The padding feature is only available on the Z/OS platform.
PAD can have two values, NULLS and BLANKS. Records are padded with NULLS When NULLS is specified. Records are padded with BLANKS when BLANKS is specified.
The default value is BLANKS.