Use the attribute definition list syntax in the Teradata PT DEFINE OPERATOR statement to declare the required attribute values for the SQL Selector 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. |
AddBOMToFile = 'option' | Optional attribute that specifies whether the UTF byte-order-mark (BOM) will be added at the beginning of an XML, JSON, or CLOB output data file. Valid values are:
AddBOMToFile can only be used when following two conditions are met:
If these two conditions are not met, the values specified in the attribute are ignored. The operator does not add a BOM to a data file extracted from a BLOB column in deferred mode. Because the default behavior is not to prefix a BOM when extracting data from XML, JSON, or CLOB columns, you should set the attribute RemoveBOMFromFile to 'No' if you use the Selector to extract XML, JSON, or CLOB data and the Inserter operator to load the data in deferred mode. For more information about RemoveBOMFromFile attribute, see SQL Inserter Operator. Teradata strongly recommends that you specify XMLSERIALIZE on selected XML columns so that the byte-order-mark (BOM) matches the XML encoding when using the client UTF-16 character set.
|
ARRAY | Optional keyword that specifies more than one attribute value. |
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 on 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 SQL Selector operator job. The values are:
|
INTEGER | Keyword that specifies INTEGER as the data type of the defined attribute. |
IsolationLevel = 'option' | Optional attribute that specifies a lock access value that determines the isolation level for all queries in a session. Valid values:
When the database successfully changes the isolation level, the following message is written to the private log: Session Isolation Level: RU |
LobDirectoryPath = 'pathName' | Optional attribute that specifies the complete path name of an existing directory where all LOB, JSON, and XML data files will be written. |
LobFileBaseName = 'fileName' | Optional attribute that defines a character string that will be prefixed to the names of LOB, JSON, and XML data files. The file names created by the SQL Selector operator are in the following format: <column-name>_c<#>_<job-id>_p<#>_r<#> where:
The column names are sanitized to replace any character that is considered invalid for a Windows file name with an underscore '_'. These are the 9 characters that get replaced: \ / : * ? " < > |
For consistency, the substitutions are done for UNIX platforms too. The '_c<#>' is added to ensure uniqueness of generated file names. For example, if we have the following schema: DEFINE SCHEMA <schema-name> ( COL2 BLOB AS DEFERRED BY NAME, COL3 CLOB AS DEFERRED BY NAME, COL4 XML AS DEFERRED BY NAME, COL5 JSON(1000000) AS DEFERRED BY NAME, ); where LobFileBaseName has the value “my_test”, then the files names will be:
|
LobFileExtension = 'fileExtension' | Optional attribute that specifies the extension for LOB, JSON, and XML data file names. Examples of ‘file-extensions’ include:
|
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, see “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, see “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 = maxDecimalDigits | Optional attribute that specifies the maximum number of digits in the DECIMAL data type that can be exported. 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. |
OutLimit=maxRecords | Optional attribute that specifies the maximum number of records processed by each instance of the operator. INTEGER OutLimit = 1000 If specified, the OutLimit value must be greater than 0. If OutLimit is not specified, the number of records processed is not limited. |
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 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 PrivateLogName attribute: tlogview -j jobid -f privatelogname If the private log is not specified, all 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. 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 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 SQL Selector operator private log. Use of the QueryBandSessInfo attribute is subject to the following rules:
|
ReportModeOn = 'option' | Optional attribute that specifies whether to use the field report mode. This feature allows you to extract data from the database in character form, and then change it into the “delimited” (VARTEXT) format using the DataConnector operator and save it to a text file. When the data is exported in character format (field report mode), columns defined in the schema must be VARCHAR. The values are:
|
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.
|
SelectStmt = 'SELECT statements;' | Required attribute that specifies a Teradata SQL SELECT statement or statements that return row data in the form of a result table. The SQL Selector operator can submit a single SELECT statement or multiple SELECT statements. All specified SELECT statements are treated as a single request to be sent to the database. The entire request cannot be larger than 1 MB (Vantage limitation). |
TdpId = 'dbcName' | Optional attribute that specifies the name of the database machine (non-mainframe platforms) or TDP (mainframe platforms) for the SQL SELECT statement. The dbcName can be up to 256 characters and can be a domain server name. If you do not specify value for the TdpId attribute, the operator uses the default TdpID established for the user by the system administrator. |
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. 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 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.
|
TreatDBSRestartAsFatal= ‘option’ | Optional attribute that tells the operator whether 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. 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 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. |