16.10 - Required and Optional Attributes - Parallel Transporter

Teradata Parallel Transporter Reference

Product
Parallel Transporter
Release Number
16.10
Published
July 2017
Content Type
Programming Reference
Publication ID
B035-2436-077K
Language
English (United States)

Use the attribute definition list syntax in the Teradata PT DEFINE OPERATOR statement to declare the required and optional attribute values for the DDL operator. See the DDL Operator Attribute Definitions table in this section for descriptions of the attributes in the following syntax diagrams. A generic example of the operator follows the attribute descriptions.





where:

DDL Operator Attribute Definitions 
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 encryption of SQL requests, responses, and data.

Valid values are:

  • ON = All SQL requests, responses, and data are encrypted
  • OFF = No encryption occurs (default)
ErrorList = ‘nnnn’ Optional attribute that specifies a list of database errors (by number) to ignore.

Using this attribute suppresses known database errors, preventing the termination of a job. This attribute overrides the default operator behavior that terminates a job whenever an error returns from the Teradata server when a DDL statement is issued.

The following example prevents the DDL operator from returning a bad status code when database error 3807 occurs during a table drop:

DEFINE OPERATOR DDLOP
DESCRIPTION 'DDL OPERATOR'
.
ATTRIBUTES
(
     VARCHAR ErrorList = '3807',
;

You can also use the ErrorList attribute to suppress multiple error codes.

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:

  • '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 32K.
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 = ‘queryBand
Expression 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:

‘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 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 DDL 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 DDL operator constructs the necessary SET QUERY BAND SQL and issues it as part of the DDL operator SQL sessions to communicate the request to the Teradata Database.
  • The DDL 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 DDL 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.

The user ID that is logged in by the DDL operator must have the REPLCONTROL privilege when setting the value for this attribute.
SPLOPT = ‘option’ Optional attribute that supports creating, replacing, and dropping an inline stored procedure using the DDL operator. The DDL operator does not execute a stored procedure. The stored procedure can be fetched with the SHOW PROCEDURE statement.

For stored procedure commands that exceed 64K, Teradata PT sends the request over in blocks of 64K, one at a time.

Valid values are:

  • 'Yes' = an internal flag is set telling the DBS to store the TDSP (default).
  • 'No’ = no internal flag is set telling the DBS to store the TDSP.
SQLCmdFileName = SQLfilepathname Optional VARCHAR attribute that specifies the complete SQL file path name. In the provided <SQLFile>, each SQL command must end with a semicolon.
TdpId = 'dbcName' Optional attribute that specifies the name of the Teradata Database machine (non-mainframe platforms) or TDP (mainframe platforms) for the DDL operator job.

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 each instance of 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' = (Default) TraceLevel turned off.
  • '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 send data with Unicode pass through characters to the Teradata Database.
Username = 'userId' Attribute that specifies the Teradata Database user name.
Use of this attribute is not compatible with some external authentication logon methods.

For more information on UserName specification requirements, see “Logon Security” in the Teradata Parallel Transporter User Guide (B035-2445).

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 the 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 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.