Use the attribute definition list syntax in the Teradata PT DEFINE OPERATOR statement to declare the required and optional attribute values for the Export operator.
where:
Syntax Element | Description |
---|---|
AccountId = 'acctId' | Optional attribute that specifies
the account associated with the specified user name. If omitted, it defaults to the account identifier of the immediate owner database. |
BlockSize = bytes | Optional attribute that specifies the block size to use when returning data to the client. The minimum is 256 bytes. The default is 1048472 bytes. The maximum is 16775168 bytes. The BlockSize value cannot be larger than the message size supported by the database. If the supplied block size is too large, the operator scales it back to the maximum allowed block size and the job continues.
|
ConnectString = 'connectionString' | Optional attribute that specifies the connection string. The connection string will be passed to CLI. CLI will validate the connection string. For information on connection string, see Teradata® Call-Level Interface Version 2 Reference for Workstation-Attached Systems, B035-2418. The TPT Connection String feature is available on all platforms, except z/OS.
|
DataEncryption = ‘option’ | Optional attribute that enables full security encryption of SQL requests, responses, and data. Valid values are:
|
DateForm = 'option' | Optional attribute that specifies
the DATE data type for the Export operator job. Valid values are:
|
DiscardLargeRow = ‘option’ | Optional attribute that tells the operator whether or not to discard large rows (greater than 64K), because the consumer operator cannot handle large rows. Valid values are:
A consumer operator cannot handle large rows when the consumer operator is talking to a database that does not support a row size greater than 64K.
When you enable this option and the consumer operator cannot handle large rows, the operator discards the large rows. The discarded rows will not be saved.
|
LogonMech = ‘string’ | Optional attribute that specifies
which logon mechanism to use. Specification of this attribute may be required for some authentication methods. The job terminates if the attribute exceeds 8 bytes. For information on specification requirements for LogonMech “Logon Security” in Teradata® Parallel Transporter User Guide, B035-2445. |
LogonMechData = ‘data’ | Optional attribute that passes
along additional logon data. Specification of this attribute is required for some external authentication methods. For information on specification requirements for LogonMechData “Logon Security” in Teradata® Parallel Transporter User Guide, B035-2445. |
LogSQL = 'option' | Optional attribute that controls how much of the job’s SQL to enter into the log. Valid options are:
|
MaxDecimalDigits = digits | Optional attribute that restricts the number of digits in the DECIMAL data type that can be exported. Valid values are from 1 to 38. The default value is 38. If the attribute has a value of q where 38≥q≥1, then any returned DECIMAL (n[,m]) data item with n>q is implicitly CAST to DECIMAL; overflows are handled the same as an explicit CAST. On mainframe-attached platforms, it is recommended that the MaxDecimalDigits attribute not exceed 31 to avoid representations that exceed the capacity of the native instruction set. |
MaxSessions = maxSessions | Optional attribute specifying the
maximum number of Export sessions to log on. The MaxSessions value must be greater than 0. Specifying a value less than 1 terminates the job. The default is one session per available AMP. The maximum value cannot exceed the number of available AMPs. |
MinSessions = minSessions | Optional attribute that specifies
the minimum number of sessions required for the Export operator job
to continue. The MinSessions value must be greater than 0 and less than or equal to the maximum number of Export operator sessions. The default is one session. |
NotifyExit = 'inmodName' | Optional attribute that specifies
the name of the user-defined notify exit routine. If no value is
supplied, the following default name is used:
See Restricted Words for information about providing your own notify exit routine. |
NotifyLevel = 'notifyLevel' | Optional attribute that indicates
the level at which certain events are reported. Valid values are:
|
NotifyMethod = 'notifyMethod' | Optional attribute that indicates
the method to be used for reporting events. The methods are:
|
NotifyString = 'notifyString' | Optional attribute that provides a
user-defined string to precede all messages sent to the system log.
This string is also sent to the user-defined notify exit routine.
The maximum length of the string is:
|
OutLimit= maxRecords | Optional attribute that specifies
the maximum number of records processed by each instance of the
operator.INTEGER OutLimit = 1000
|
PrivateLogName = 'logName' | Optional attribute that specifies
the name of a log that is maintained by the Teradata PT Logger
inside the public log. The private log contains all of the output
provided by the Export operator. The private log can be viewed using the tlogview command as follows, where jobid is the Teradata PT job name and privateLogName is the value for the Export operator PrivateLogName attribute: tlogview -j jobid -f privatelogname If the private log is not specified, all of the output is stored in the public log. For more information about the tlogview command, see Teradata PT Utility Commands. |
QueryBandSessInfo = 'queryBandExpression' | Optional attribute that specifies the Query Band for the duration of the job sessions. queryBandExpression is a set of name=value pairs, separated by a semicolon and ending with a semicolon. The user defines the Query Band expression, which will look similar to the following example: ‘org=Finance;load=daily;location=west;’ QueryBandSessInfo may also be specified as an ARRAY attribute. For information on the rules for creating a Query Band expression, see Teradata Vantage™ - SQL Data Definition Language Syntax and Examples, B035-1144 and Teradata Vantage™ - SQL Data Definition Language Detailed Topics, B035-1184. The value of the QueryBandSessInfo attribute is displayed in the Export operator private log. Use of the QueryBandSessInfo attribute is subject to the following rules:
|
RoleName - 'role name' | Optional attribute that implements security in a database environment. The operator will prepend the value with "SET ROLE ". The syntax will be sent to the database as follows: SET ROLE <role name>; For example: SET ROLE All; For details of SET ROLE command use, see Teradata Vantage™ - SQL Data Definition Language Syntax and Examples, B035-1144. The VARCHAR ARRAY can specify more than one value, for example: VARCHAR ARRAY RoleName = ['role name1', 'role name2'], The operator will send the request to the database on the SQL session after the session is connected. The operator does not send the request on the FastExport protocol sessions, because the database does not allow the request to be sent on the FastExport protocol sessions.
|
SelectStmt = 'SELECT statements;’ | Required attribute that specifies the SQL SELECT statement (or statements). Refer to the SQL reference for your operating system and enter one or more valid SQL SELECT statements for the SelectStmt attribute. The statement, or statements, must be enclosed in single quotes and each statement must be terminated with a semicolon. |
SpoolMode = 'option' | Optional attribute that specifies
which spooling mode to use for the answer set.
|
VARCHAR TASMFASTFAIL = ‘value’ | Optional attribute that enables FASTFAIL. Valid values are:
|
TdpId = 'dbcName' | Optional attribute that specifies the name of the database machine (non-mainframe platforms) or TDP (mainframe platforms) for the Export operator job. The dbcName can be up to 256 characters and can be a domain server name. The dbcName is the name of the host entered in the network hosts file. If you do not specify the value for the TdpId attribute, the operator uses the default TdpID established for the user by the system administrator. On a mainframe, a single-character TdpId is supported. When only one character is specified, it is assumed to be an abbreviation for a four-character TdpId that begins with TDP.
|
TenacityHours = hours | Optional attribute that specifies the number of hours that the Export operator continues trying to log on when the maximum number of Update/Export/Load jobs are already running on the database. The default value is 4 hours. To enable the tenacity feature, hours must be greater than 0. Specifying a value of 0 will disable the tenacity feature. Specifying a value of less than 0 terminates the job. |
TenacitySleep = minutes | Optional attribute that specifies the number of minutes that the Export operator pauses before retrying a logon operation when the maximum number of Update/Export/Load operator jobs are already running on the database. The minutes value must be greater than 0. If you specify a value less than 1, the Export operator responds with an error message and terminates the job. The default is 6 minutes. |
TimeZoneSessInfo = 'timeZoneValue' | Optional attribute that allows you to change the default time zone displacement for the duration of the operator's job session. When you provide a value for this attribute, the operator will build the "SET TIME ZONE <timeZoneValue>;" SQL request. The operator will send the request to the database on the SQL session after the session is connected. The operator does not send the request on the FastExport protocol sessions, because the database does not allow the request to be sent on the FastExport protocol sessions. Here are some examples:
For more information on SET TIME ZONE SQL, see Teradata Vantage™ - SQL Data Definition Language Syntax and Examples, B035-1144. |
TraceLevel = 'level' | Optional attribute that specifies
the types of diagnostic messages that are written by each instance
of the operator to the to the public log (or private log, if one is
specified using the PrivateLogName attribute). The diagnostic trace
function provides more detailed information in the log file to aid
in problem tracking and diagnosis. The trace levels are:
The VARCHAR ARRAY can specify more than one value, for example: VARCHAR TraceLevel = 'CLI' VARCHAR TraceLevel = 'OPER' VARCHAR ARRAY TraceLevel = [ 'CLI' ] VARCHAR ARRAY TraceLevel = [ 'CLI', 'OPER' ] The TraceLevel attribute is
provided as a diagnostic aid only. The amount and type of
additional information provided by this attribute will change to
meet evolving needs from release to release.
|
TransformGroup = 'transformgroupname' | Optional attribute that supports changing the active transform for Teradata Complex Data Types (CDTs). The value is the <udt name> <transform group name>, and the operator will prepend the hardcoded string "SET TRANSFORM GROUP FOR TYPE ". The syntax sent to RDBMS is as follows: SET TRANSFORM GROUP FOR TYPE <udt name> <transform group name>; For example:
"SET TRANSFORM GROUP FOR TYPE JSON CHARACTER SET LATIN TD_JSON_VARCHAR;" The VARCHAR ARRAY can specify more than one value, for example:
VARCHAR ARRAY TransformGroup = ['JSON CHARACTER SET LATIN TD_JSON_VARCHAR', 'ST_GEOMETRY TD_GEO_VARCHAR'], The operator will send the request to the database on the SQL session after the session is connected. The operator does not send the request on the FastExport protocol sessions, because the database does not allow the request to be sent on the FastExport protocol sessions.
|
TreatDBSRestartAsFatal= ‘option’ | Optional attribute that tells the operator whether or not to terminate the job when a database restart occurs. The TreatDBSRestartAsFatal values are:
|
UnicodePassThrough = ‘value’ | Optional attribute that tells the operator to enable or disable the Unicode Pass Through feature. Valid values:
When a TPT job is using the UTF8 or UTF16 session character set, the UnicodePassThrough attribute can be set to 'On' to allow the operator to export data with Unicode pass through characters.
|
UserName = 'userId' | Attribute that specifies the user name on the database. Use of this attribute is not compatible with some external authentication logon methods. For more information on username specification requirements, see “Logon Security” in Teradata® Parallel Transporter User Guide, B035-2445.
|
UserPassword = 'password' | Attribute that specifies the password associated with the database user name. Use of this attribute is not compatible with some external authentication logon methods. For more information on password specification requirements, see “Logon Security” in Teradata® Parallel Transporter User Guide, B035-2445.
|
VARCHAR | Keyword that specifies VARCHAR as the data type of the defined attribute. |
WorkingDatabase = 'databaseName' | Optional attribute that specifies a database other than the logon database as the default database. The name of the database that is specified with this attribute is used in the SQL DATABASE statement that is sent by the operator immediately after connecting the two SQL sessions. If WorkingDatabase is not specified, the default database associated with the logged on user is assumed for all unqualified table names. |