Attribute and Type | Type | Description |
---|---|---|
TD_ACCOUNT_ID | varchar | Specifies the account associated with the specified user name. When omitted, this attribute defaults to the account identifier of the immediate owner database. |
TD_AUTORESTART | varchar | Teradata PT APT notifies the user
application, once Teradata Database restarts, that the database
crashed. Valid values are:
|
TD_BLOCK_SIZE | integer | Specifies the block size in bytes used
when returning data to the client. The minimum is 256 bytes. The default and maximum are 16775168 bytes. This value cannot be larger than the
message size supported by the Teradata Database. If the supplied
block size is too large, the operator scales it back to the maximum
allowed block size and job continues.
|
TD_BUFFER_HEADER_SIZE | integer | Specifies the row header size allocated for each row in the data buffer returned by the GetBuffer function. The row header size must be greater than or equal to the value for the TD_BUFFER_LENGTH_SIZE attribute. The default row header size is the value for the TD_BUFFER_LENGTH_SIZE attribute. For more information on using the GetBuffer function, see Export Data from a Teradata Database using GetBuffer . |
TD_BUFFER_LENGTH_SIZE | integer | Specifies the row length size allocated for each row in the data buffer returned by the GetBuffer function. Valid row length size values are:
For more information on using the GetBuffer function, see Export Data from a Teradata Database using GetBuffer. |
TD_BUFFER_MAX_SIZE | integer | Specifies the total maximum size for the data buffer returned by the GetBuffer function. The total maximum size of the data buffer must be large enough to hold at least one row of data including the row header, the actual row of data, and the buffer trailer. When exporting variable length data, the largest row size possible is used when calculating the minimum total maximum size of the data buffer. The default total maximum size of the data buffer is 16775552 (roughly 16384k). For more information on using the GetBuffer function, see Export Data from a Teradata Database using GetBuffer. |
TD_BUFFER_TRAILER_SIZE | integer | Specifies the size of the buffer trailer allocated for the data buffer returned by the GetBuffer function. The default buffer trailer size is zero. For more information on using the GetBuffer function, see Export Data from a Teradata Database using GetBuffer. |
TD_CHARSET | varchar | Specifies the name or code of the character set to be used for the job. On mainframe-attached z/OS platforms, only EBCDIC encoding is supported and is automatically selected. For the list of supported character sets, see “Extended Character Sets” in Teradata Parallel Transporter Reference (B035-2436). |
TD_DATA_ENCRYPTION | varchar | Activates full security encryption of
SQL requests, responses and data. Valid values are:
|
TD_DATE_FORM | varchar | Specifies the DATE data type for the
Export driver job. Valid values are:
|
TD_DISCARDLARGEROW | varchar | 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 Teradata 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 will
discard the large rows. The discarded rows will not be
saved.
This option applies only for the
FastExport NoSpool mode, because the operator does not know ahead of
time whether any rows will be too large for the consumer
operator.
This option does not apply for the
FastExport Spool mode, because the operator knows ahead of time
whether any rows will be too large for the consumer operator. When
the operator knows ahead of time, the operator will terminate the
job right away where there is 1 or more large rows.
|
TD_JOBMAXROWSIZE | integer | The TPTAPI application tells the Export operator the maximum row size it can support. This is the information that the Export operator needs for the DiscardLargeRow feature. Valid values are:
|
TD_LOGON_MECH | varchar | Specifies which logon mechanism to
use. See your site security administrator for specific mechanism names. For a list of available mechanisms, see Security Administration (B035-1100). The job terminates if the attribute exceeds eight bytes. |
TD_LOGON_MECH_DATA | varchar | Passes additional logon mechanism data. See your site security administrator for specific mechanism data. For more information, see Security Administration (B035-1100). |
TD_MAX_DECIMAL_DIGITS | integer | Specifies the maximum number of decimal digits (a value for the maximum precision) to be returned by the database. Valid values range from 1 to 38 inclusive. The default value is 38. |
TD_MAX_SESSIONS | integer | Specifies the maximum number of
sessions to log on. This MaxSessions value must be greater than one. Specifying a value less than one terminates the job. The default is one session per available AMP. The maximum value cannot be more than the number of AMPS available. The MaxSessions value must be greater than or equal to the value of TD_MAX_INSTANCES. |
TD_MIN_SESSIONS | integer | Specifies the minimum number of
sessions required for the Export driver job to continue. The default is
one session. The MinSessions value must be greater than one and less than or equal to the maximum number of Export driver sessions. Specifying a value less than one terminates the Export driver. |
TD_MSG_ENCODING | TD_Encoding | Specifies the encoding for the messages passed between Teradata PT and a Teradata PT application. |
TD_NOTIFY_EXIT | varchar | Specifies the name of the user-defined
notify exit routine. When no name is supplied, the following default names are used:
For detailed information on the Notify feature, see “Export Operator” in Teradata Parallel Transporter Reference (B035-2436). |
TD_NOTIFY_LEVEL | varchar | Indicates the level at which certain
events are reported. The valid settings are: Off = No notification of events is provided. This is the default setting. Low = Notification is provided for these events:
Medium = Notification is provided for all the events except for:
High = Notification is to be provided for all events. |
TD_NOTIFY_METHOD | varchar | Specifies the method for reporting
events. Valid methods are:
|
TD_NOTIFY_STRING | varchar | Specifies a user-defined string that
precedes 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:
|
TD_OUTLIMIT | integer | Limits the number of rows that the Export driver exports. The default setting is No limit. Valid values are any non-negative integer value. In a multiple instance environment, this limit applies only to the particular instance on which it is set, and not to the overall job. For example, in an Export job with one master instance and one slave instance, if the out limit for both the master and the slave is set to 10 rows, then the master instance stops after exporting 10 rows and the slave instance stops after exporting 10 rows. |
TD_QUERY_BAND_SESS_INFO | varchar | Provides a user-defined query band
expression that is set for every SQL session connected by the Teradata
PT driver. The following is an example of a valid query band
expression:a=1;b=2;c=3;d=4; If the TD_QUERY_BAND_SESS_INFO is set, the following request will be sent by every SQL session connected by the Teradata PT Export driver: SET QUERY_BAND =’<User-Defined Query Band Expression>’ FOR SESSION;
Setting the TD_QUERY_BAND_SESS_INFO attribute in jobs running against non-supported versions of the Teradata Database causes a non-fatal error. No error code is returned to the user during initiation and the job is allowed to proceed. The log table will not be dropped at the end of the job and the TD_Evt_ExitCode event returns a warning value of four instead of the normal success value of zero if queried. In this case, error information can be found in the trace file. |
TD_RETN_ACT_DATATYPE | varchar | Enables or disables returning the
actual column data type. Valid vales are:
For a sample TPTAPI program to implement Return Actual Data Type, see Sample Export_To_Load Program for Returning the Actual Data Type. For conversion information, see Converting TIME, TIMESTAMP, and INTERVAL Data Types. |
TD_ROLENAME | varchar | Sets the current role for a session. The valid values are:
The value for the attribute needs to be provided by the user, and the operator will prepend the hard-coded string SET ROLE . For details, see SQL Data Definition Language Syntax and Examples B035-1144. TPTAPI and the operator do not validate the value for this attribute. The operator passes the value to the Teradata Database as is. The Teradata Database will validate the value. The operator will terminate the job with a Teradata Database error when the validation fails.
C style comments are allowed in the value and will be passed to the Teradata Database.
ANSI style comments are not supported in the value. The operator can terminate the job with a Teradata Database syntax error when the value contains an ANSI style comment.
A semicolon is not allowed in the value, because the operator allows only a single statement per request. The TPTAPI Application will Terminate, as Operator will terminate the job with an operator error when the value contains a semicolon.
|
TD_SPOOLMODE | varchar | Specifies whether to use spool or not
while running the current Export job. Valid values are:
|
TD_TASMFASTFAIL | varchar | Enables/disables TASM FastFail feature
for Export Driver. Valid values are:
|
TD_TDP_ID | varchar | Specifies the name of the Teradata
Database machine.
|
TD_TENACITY_HOURS | integer | Specifies the number of hours the
Export driver attempts to log on when the maximum number of load and
export operations are already running on the Teradata Database.
|
TD_TENACITY_SLEEP | integer | Specifies the number of minutes the
Export driver pauses before attempting to log on when the maximum number
of load and export operations are already running on the Teradata
Database. The default is six minutes. This value must be greater than one. If you specify a value less than one, the Export driver responds with an error message and terminates the job. |
TD_TIME_ZONE_SESS_INFO | varchar | 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 Teradata Database on the SQL session after the session is connected. The operator does not send the request on the FastExport protocol sessions, because the Teradata Database does not allow the request to be sent on the FastExport protocol sessions. Following are some of the possible valid values:
TPTAPI and the operator do not validate the value for this attribute. The operator passes the value to the Teradata Database as is. The Teradata Database will validate the value. The operator will terminate the job with a Teradata Database error when the validation fails.
C style comments are allowed in the value and will be passed to the Teradata Database.
ANSI style comments are not supported in the value. The operator will terminate the job with a Teradata Database syntax error when the value contains an ANSI style comment.
A semicolon is not allowed in the value, because the operator allows only a single statement in the "SET TIME ZONE SQL" request. The TPT API application will terminate, because the operator will terminate the job with an operator error when the value contains a semicolon.
For more information on the SET TIME ZONE SQL attribute, see the Teradata Database SQL Data Definition Language Syntax and Examples manual. |
TD_TMSMSUPPORT | varchar | Enables and disables sending events to
TMSM. Valid values are: Yes ('Y') = enables sending events to TMSM (default) No ('N') = disables sending events to TMSM |
TD_TRACE_LEVEL
The TraceLevel attribute is an internal
diagnostic aid. Use only if instructed to by Teradata support.
TD_OFF should always be specified.
|
integer | Specifies the types of diagnostic
messages written by each instance of the driver to an external log file.
The diagnostic trace function provides more detailed information in the
log file (including the version number) to aid in problem tracking and
diagnosis. Use the AddArray attribute method to specify the two types of tracing levels: driver tracing and infrastructure tracing. TD_OFF is the default setting for both driver tracing and infrastructure tracing. No external log file is produced unless this default is changed. Specifying TD_OFF for both driver tracing and infrastructure tracing is the same as disabling tracing. If the TraceLevel is set to any value other than TD_OFF, an external log file is created for each instance of the driver. The trace levels for driver tracing are:
The trace levels for infrastructure tracing should only be used when you are directed to by Teradata support. TD_OFF, which disables infrastructure tracing, should always be specified. |
TD_TRACE_OUTPUT | varchar | Specifies the name of the external file
used for tracing messages. The default setting creates a new file name
with the name of the driver followed by a time stamp. If a file with the specified name
already exists, that file will be overwritten.
|
TD_TRANSFORM_GROUP | varchar | Sets the active transform for Complex Data Types (CDTs) with multiple transforms in the current session. The following CDTs have multiple transforms:
When a value is provided for this attribute, the operator builds the "SET TRANSFORM GROUP FOR TYPE <tranformgrouValue>;" SQL request. The operator sends the request to the Teradata Database on the SQL session, after the session is complete. TPTAPI and the operator do not validate the value for this attribute. The operator passes the value to the Teradata Database as is. The Teradata Database validates the value. The operator terminates the job with a Teradata Database error when the validation fails.
C style comments are allowed in the value and will be passed to the Teradata Database.
ANSI style comments are not supported in the value. The operator will terminate the job with a Teradata Database syntax error when the value contains an ANSI style comment.
A smicolon is not allowed in the value, because the operator allows only a single statement per request. TPTAPI will terminate the job with an operator error when the value contains a semicolon.
|
TD_UNICODEPASSTHROUGH | varchar | Enables and disables the Unicode Pass
Through feature for the Export Driver. Valid values are: On = enable the Unicode Pass Through feature Off = disable the Unicode Pass Through feature (default). |
TD_WORKINGDATABASE | varchar | Specifies the name of the database used in the Teradata SQL DATABASE statement sent by the Export driver to the Teradata Database immediately after connecting the two SQL sessions. Use this attribute to specify a default database other than the logon database. |