Optional Attributes
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_BUFFER_SIZE |
integer |
Specifies the output buffer size, in kilobytes, used for sending Load parcels to the Teradata Database. |
TD_CHARSET |
varchar |
Character Set is the name of the session character set used for the job. On mainframe‑attached z/OS platforms, only EBCDIC encoding is supported and is automatically selected. For the list of supported session character sets, see “Extended Character Sets” in Teradata Parallel Transporter Reference. In a multi-instance environment the master and all the slave instances should have the same session character set. Also, the data for each instance should be in the same character set as the session character set. If the master instances does not use the TD_CHARSET attribute then the slave instance(s) should not use the attribute. If the master instance specifies a different session character set than any of its slave instances then the Load, Export, and Update drivers will use the master instance’s session character set for the entire job. The Stream driver, however, will let each instance use its own session character set for the job. Also, note that the session character set for all instances should not change if a restart occurs. If any instance specified a value for TD_CHARSET before the restart then that instance needs to specify the same value for TD_CHARSET when the connection is initiated again and then restarted. |
TD_DATA_ENCRYPTION |
varchar |
Makes full security encryption of SQL requests, responses, and data available. |
TD_DATE_FORM |
varchar |
Specifies the DATE data type for the Load driver job. |
TD_DROPERRORTABLE |
varchar |
Directs the Load driver to drop the existing error tables at the end of the job. By default, the Load driver drops the error tables at the end of a job if the error tables are empty. If the error tables are not dropped at the end of a successfully terminating job and the same error table names are used in a subsequent Load job then the Teradata Database will return an error on those subsequent Load jobs, even if those error tables are empty. Valid values are: |
TD_DROPLOGTABLE |
varchar |
Directs the Load driver to drop the existing restart log table at the end of the job. By default, the Load driver drops the restart log table at the end of a job only if the job completes successfully. If the restart log table is not dropped at the completion of a successful job and the same restart log table name is provided in a subsequent Load job then the results will be unpredictable. This unpredictability is due to the nature of the Teradata FastLoad protocol, where the existence of a restart log table implies the job is a restart and the Load driver may attempt to restart the job at a point in time as dictated by the contents of the restart log table. The Load driver will try to detect whether this situation has occurred and will attempt to terminate the job with a meaningful error message but this attempt is dependent upon the contents of the restart log table. Valid values are: |
TD_ERROR_LIMIT |
integer |
Specifies the maximum number of records stored in one of the error tables before the Load driver job is terminated. The ErrorLimit specification applies to each instance of the Load driver. |
TD_ERROR_TABLE_1 |
varchar |
Specifies the name of the first error table. This must be a new table name. You cannot use a name that duplicates the name of an existing table unless you are restarting a paused Load driver job. For more information on the error table format and the procedure to correct errors, see “FastLoad Errors” in Teradata FastLoad Reference. |
TD_ERROR_TABLE_2 |
varchar |
Specifies the name of the second error table. This must be a new table name. You cannot use a name that duplicates the name of an existing table unless you are restarting a paused Load driver job. For more information on the error table format and the procedure to correct errors, see “FastLoad Errors” in Teradata FastLoad Reference. |
TD_LOGSQL |
varchar |
Directs the Load driver to output the full Teradata SQL request in the trace output file when the driver’s trace is enabled. Valid values: Note: When the driver’s trace is disabled, TD_LOGSQL has no effect. |
TD_LOGON_MECH |
varchar |
Specifies which logon mechanism to use. |
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. |
TD_MAX_SESSIONS |
integer |
Specifies the maximum number of sessions to log on. |
TD_MIN_SESSIONS |
integer |
Specifies the minimum number of sessions required for the Load driver job to continue. |
TD_MSG_ENCODING |
TD_ |
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 with an entry point named _dynamn. If no name is supplied, the following default names are used: For detailed information on the Notify feature, see “Load Operator” in Teradata Parallel Transporter Reference. |
TD_NOTIFY_LEVEL |
varchar |
Indicates the level at which certain events are reported. The valid settings are: |
TD_NOTIFY_METHOD |
varchar |
Specifies the method for reporting events. The methods are: On Windows, the events are sent to the EventLog that can be viewed using the Event Viewer. The messages are sent to the application log. On AIX, HP‑UX, Linux, and Solaris platforms, the destination of the events is specified in the /etc/syslog.conf file. |
TD_NOTIFY_STRING |
varchar |
Provides 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_PAUSE_ACQ |
varchar |
Specifies whether to pause the Load job after the acquisition phase or enter the application phase. Valid values are: |
TD_TMSMSUPPORT |
varchar |
Enables and disables sending events to TMSM. Valid values are: ‘Y]es]’ = enables sending events to TMSM (default) ‘N[o]’ = disables sending events to TMSM |
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 Load 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_TDP_ID |
varchar |
Specifies the name of the Teradata Database machine. |
TD_TENACITY_HOURS |
integer |
Specifies the number of hours that the Load driver continues trying 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 Load driver pauses before retrying to log on when the maximum number of Load or Export operations are already running on the Teradata Database. |
TD_TRACE_LEVEL Note: 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 trace messages. The default setting creates a new file name using the name of the driver followed by a time stamp. Note: If a file with the specified name already exists, then the file is overwritten. |
TD_WILDCARDINSERT |
varchar |
Builds an INSERT statement from the table definition. Valid values are: If you set this attribute to Yes and a valid fully supported INSERT statement already exists, an error results. To be valid, the table name must match the name of the table used in the TargetTable attribute and a semicolon must be the last non‑space character in the supplied DML statement as follows: INS[ERT] [INTO] <tablename>;
|
TD_WORKINGDATABASE |
varchar |
Specifies the name of the database used in a Teradata SQL DATABASE statement that the Load driver sends to the Teradata Database immediately after connecting the two SQL sessions. Use this attribute to specify a default database other than the logon database. |