16.10 - Required and Optional Attributes - Parallel Transporter

Teradata Parallel Transporter Reference

Parallel Transporter
Release Number
July 2017
Content Type
Programming Reference
Publication ID
English (United States)

Use the attribute definition list syntax in the Teradata PT DEFINE OPERATOR statement to declare the required attribute values for the SQL Inserter operator.


SQL Inserter Operator Attribute Descriptions 
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.

ARRAY Optional keyword that specifies more than one attribute value.
DataEncryption = 'option' Optional attribute that enables full security encryption of SQL requests, responses, and data.

Valid values are:

  • ‘On’ = all SQL requests, responses, and data are encrypted.
  • ‘Off’ = no encryption occurs (default).
DateForm = 'option' Optional attribute that specifies the DATE data type for the SQL Inserter operator job where:
  • 'integerDate' = the integer DATE data type (default)
  • 'ansiDate' = the ANSI fixed-length CHAR(10) DATE data type
DeleteLobDataFiles = 'option' Optional attribute that specifies whether to delete deferred LOB data files from the Data Connecter Producer once the rows are committed to database.

Valid values are:

  • ‘Yes’ (or ‘Y’) = delete deferred mode LOB data files once rows are committed to the database.
  • ‘No’ (or ‘N’) = do not delete deferred mode LOB data files (default).

Specifying any other value results in an error.

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” 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:

  • 'Yes' = output the full SQL to the log. The maximum length is 1M.
  • 'No' = do not output SQL to the log.
  • No value or attribute omitted = accept the pre-defined limit, which displays up to 32K of SQL if all of the SQL is less than 32K. If the SQL to be logged exceeds 32K, truncate the display to the first 32K bytes.
MaxSessions = ‘maxSessions Optional attribute that specifies the maximum number of sessions to log on. The MaxSessions value must be greater than 0. Specifying a value less than 1 terminates the job.

The default value is one session for each operator instance.

The main instance calculates an even distribution of the Inserter operator sessions among the number of instances. For example, if there are 4 instances and 16 sessions, each instance will log on 4 sessions.

If multiple sessions are used and the data has duplicate primary index values, this could result in a potential Teradata Database deadlock 2631 error. To avoid this error, do not use multiple sessions with the TPT SQL Inserter operator.
MinSessions = ‘minSessions Optional attribute that specifies the minimum number of sessions required for the Stream operator job to continue.

The MinSessions value must be greater than 0 and less than or equal to the maximum number of sessions defined in the attribute MaxSessions.

Specifying a value less than 1 terminates the job.

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 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 operator’s PrivateLogName attribute:

tlogview -j jobid -f privatelogname

If the private log is not specified, all 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.

The 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:


QueryBandSessInfo may also be specified as an ARRAY attribute.

For information on the rules for creating a Query Band expression SQL Data Definition Language Syntax and Examples (B035-1144) and SQL Data Definition Language Detailed Topics (B035-1184).

The value of the QueryBandSessInfo attribute is displayed in the SQL Inserter operator private log.

Use of the QueryBandSessInfo attribute is subject to the following rules:

  • By default, Query Band is off until a valid value appears for the QueryBandSessInfo attribute.
  • If the QueryBandSessInfo attribute contains a value, the SQL Inserter operator constructs the necessary SET QUERY BAND SQL to communicate the request to the Teradata Database.
  • The SQL Inserter operator does not check the Query Band expression, but passes the expression to Teradata Database as is.
  • If the version of Teradata Database against which the job is being run does not support the Query Band feature, no Query Banding will take place. However, the operator will ignore the error and run the rest of the job.
  • If there is a syntax error in the Query Band expression, Teradata Database will return an error. The SQL Inserter operator will then terminate the job and report the error to the user.
ReplicationOverride = 'option' Optional attribute that overrides the normal replication services controls for an active session.

Valid values:

  • ‘On’ = override normal replication services controls for the active session.
  • ‘Off’ = override of normal replication services is turned off for the active session (when change data capture is active).
  • ‘None’ = (Default) No override request is sent to the Teradata Database.

For more information, see Teradata Replication Services Using Oracle GoldenGate (B035-1152).

The user ID that is logged in by the operator must have the REPLCONTROL privilege when setting the value for this attribute.
RemoveBOMFromFile = 'option' Optional attribute that specifies whether or not to look for and remove the UTF byte-order-mark (BOM) from the beginning of an XML, JSON, or CLOB data file

Valid values are:

  • 'Y’ or ‘Yes' = The Inserter operator looks for the UTF BOM at the beginning of an XML, JSON, or CLOB data file and, if found, removes it before processing (default)

    If the found BOM is not valid for the client Unicode character set, the operator displays an error message and terminates the job.

    If the BOM is not found, the Inserter operator processes the file without an error message or warning message being logged to the private log or to the console

  • 'N’ or ‘No' = The Inserter operator does not look for the UTF BOM.

    Teradata recommends that RemoveBOMFromFile be set to 'No' when moving XML, JSON or CLOB data in deferred mode encoding in the Unicode character set from one Teradata Database table to another. This can improve loading performance when large amount of data (for example, million rows) are inserted in a table in the deferred mode.

RemoveBOMFromFile can only be used when the following two conditions are met:

The job schema has one or more XML, JSON and/or CLOB column(s) defined AS DEFERRED BY NAME.

The client character set for the load job is the Unicode character set.

If these two conditions are not met, the values specified in the attribute are ignored.

TdpId = 'dbcName' Optional attribute that specifies the name of the Teradata Database machine (non-mainframe platforms) or TDP (mainframe platforms) for the insert operation.

The dbcName can be up to 256 characters and can be a domain server name.

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.
TraceLevel = 'level' Optional attribute that specifies the types of diagnostic messages that are written by the operator 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:

  • 'None' = TraceLevel turned off (default).
  • 'CLI' = enables the tracing function for CLI-related activities (interaction with the Teradata Database)
  • 'PX' = enables the tracing function for activities related to the Teradata PT infrastructure
  • 'Oper' = enables the tracing function for operator-specific activities
  • 'All' = enables tracing for all of the above activities

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 changes to meet evolving needs from release to release.
TreatDBSRestartAsFatal= ‘option Optional attribute that tells the operator whether or not to terminate the job when a Teradata Database restart occurs.

The TreatDBSRestartAsFatal values are:

  • ‘No’ (‘N’) = The operator will not terminate if a Teradata Database restart occurs (default). The Teradata Database restart will be treated as a retryable one.
  • ‘Yes’ (‘Y’) = The operator will terminate if a Teradata Database restart occurs.
UnicodePassThrough = ‘value Optional attribute that tells the operator to enable or disable the Unicode Pass Through feature.

Valid values:

  • 'On' = Enable the Unicode Pass Through feature in the operator.
  • 'Off' = (Default) Disable the Unicode Pass Through feature in the operator.
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 load data with Unicode pass through characters.
UserPassword = 'password' Attribute that specifies the password associated with the 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 theTeradata 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 Teradata 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.