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_APPENDERRORTABLE |
varchar |
Directs the Stream driver to use the existing error table that is specified in the TD_ERROR_TABLE attribute. By default, if the specified error table already exists, the Stream driver terminates the job with an error message. Note: Set the TD_DROPERRORTABLE attribute to align the Stream driver default setting. Valid values are: |
TD_ARRAYSUPPORT |
varchar |
Specifies default array support option for all DMLGroups. Each DMLGroup can modify this setting through the AddArraySupport function. Valid values are: Note: Performance will improve when Array Support is enabled. |
TD_BUFFERS |
integer |
Specifies whether to increase the number of request buffers. The range of values has a lower limit of two and no upper limit. The default value is three. The maximum number of request buffers you can allocate is the number of buffers multiplied by the number of connected sessions. Because request buffers are a global resource, buffers are assigned to any session as needed and then returned to a free pool. At any point in time, the number of request buffers assigned to a session can vary from zero to the maximum number you allocate. |
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. |
TD_DATA_ENCRYPTION |
varchar |
Provides full security encryption of SQL requests, responses and data. Valid values are: |
TD_DATE_FORM |
varchar |
Specifies the DATE data type for the Stream driver job. Valid settings are: |
TD_DROPERRORTABLE |
varchar |
Directs the Stream driver to drop the existing error table at the end of the job. By default, the Stream driver drops the error table at the end of a job if the error table is empty. Note: Use the TD_APPENDERRORTABLE attribute to direct the Stream driver to continue using the existing error table. Valid values are: |
TD_DROPMACRO |
varchar |
Specifies whether to keep or drop the macro created during the current Stream job. Valid values are: |
TD_ERROR_LIMIT |
integer |
Specifies the maximum number of records stored in one of the error tables before the Stream driver job is terminated. By default, the ErrorLimit value is unlimited. The ErrorLimit specification must be greater than zero. Specifying an invalid value terminates the Stream driver. The ErrorLimit specification applies to each instance of the Stream driver. |
TD_ERROR_TABLE |
varchar |
Specifies the name of the error table. ErrorTable must be a new table name. You cannot use the name of an existing table unless you are restarting a Stream driver job. If the name is not supplied, it will be created by the Stream driver. The Error Table contains information concerning: It is acceptable, and even good practice, to prefix the error table with a database name as a qualifier. This means that because the database may have a lot of PERM space, which space will not have to be increased for all databases with tables involved in the load. If the database for the error table is not specified, the table is placed in the database associated with the user logon. See “Reading TPump Error Tables” in Teradata Parallel Data Pump Reference for information on the error table format and the procedure to correct errors. |
TD_LOGON_MECH |
varchar |
Specifies which logon mechanism is used. |
TD_LOGON_MECH_DATA |
varchar |
Passes along additional logon mechanism data. See your site security administrator for specific mechanism data. For more information, see Security Administration. |
TD_LOGSQL |
varchar |
Directs the Stream driver to output the full Teradata SQL request in the trace output file with the driver’s trace is enabled. By default, when the driver’s trace is enabled, the Stream driver outputs the Teradata SQL request, up to 32 kilobytes, in the trace output file. Valid values: Note: When the driver’s trace is disabled, TD_LOGSQL has no effect. |
TD_MACROCHARSET |
varchar |
Enables or disables the MacroCharSet feature. If the TD_MACROCHARSET attribute is enabled, you can specify the column MacroCharSet name for character columns. The value is discarded for other column types. Valid values: For syntax to enable TD_MACROCHARSET and the AddColumn syntax when TD_MACROCHARSET is enabled, see “Using the MacroCharSet Feature” on page 144. |
TD_MACRODATABASE |
varchar |
Specifies the database that contains any macros used by the Stream driver. The default macro database is the restart log table database. |
TD_MAX_SESSIONS |
integer |
Specifies the maximum number of sessions to log on. 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 zero. Specifying a value less than one causes the job to terminate. 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 Stream driver job to continue. The default is one session. The MinSessions value must be greater than zero and less than or equal to the maximum number of Stream driver sessions. Specifying a value less than one terminates the Stream driver. |
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 “Stream 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 |
Indicates the method used 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 dependent upon the setting specified in the file called /etc/syslog.conf. |
TD_NOTIFY_STRING |
varchar |
Provides a user-defined string to precede 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_PACK |
integer |
Specifies the number of statements to pack into a multiple-statement request. The default value is 20. The maximum value is 600. |
TD_PACKMAXIMUM |
varchar |
Triggers the Stream driver to dynamically determine the maximum possible pack factor for the current Stream job. Valid values are: |
TD_PERIODICITY |
integer |
Specifies that the DML statements sent by the Stream driver to the Teradata Database be as evenly distributed as possible over each one minute interval. The periodicity value sets the number of sub-intervals per minute. The TPT API user needs to pass the user's command for the Periodicity option to TPT API. TPT API needs to pass the user's command to the Stream driver. For example, if the rate is 1600 and the periodicity is 10, then the maximum number of statements submitted is 160 (1600/10) every 6 (60/10) seconds. Valid values are between 1 and 600. The default value is 4, that is, four 15-second intervals per minute. If the statement rate is unlimited, the periodicity value is ignored. |
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 Stream 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_RATE |
integer |
Specifies the maximum number of DML statements per minute that the Stream driver can submit to the Teradata Database per minute. The user needs to pass the command for the Rate option to TPT API. TPT API needs to pass the user command to the Stream driver. When a job step contains multiple occurrences of the Stream driver with differing Rate values, Teradata PT automatically uses the lowest Rate value for all instances. Values for TD_RATE must be one of the following: 'unlimited' tells the Stream driver to send as many DML statements to the Teradata Database as the user specified. |
TD_REPLICATION_OVERRIDE |
varchar |
Overrides the normal replication services controls. The default is not to send any
The following valid values are not case sensitive: SET SESSION OVERRIDE REPLICATION ON to the database. Normal replication services controls are overridden.
SET SESSION OVERRIDE REPLICATION OFF to the database. Normal replication services controls are not overridden.
For detailed information on replication services components, see Teradata Replication Services Using Oracle GoldenGate and SQL Data Definition Language. |
TD_ROBUST |
varchar |
Specifies whether or not to use robust restart logic for recovery and restart operations. In robust mode, one database row is written in the log restart table for every request issued. These rows are the request log. Because the Teradata Database completely finishes or rolls back, a the request log always accurately reflects the completion status of an import. Valid values are: In Robust recovery mode, the Stream driver must next ascertain how much processing has been completed since the last logged checkpoint. This is accomplished by reading back a set of Partial Checkpoints from the Teradata Database, sorting them and then reprocessing all transactions that were left incomplete when the job was interrupted. If you are not sure about using robust restart logic, it is always safe to set the robust attribute to Yes. |
TD_TDP_ID |
varchar |
Specifies the name of the Teradata Database machine. |
TD_TENACITY_HOURS |
integer |
Specifies the number of hours that the Stream 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 that the Stream driver pauses before retrying to log on when the maximum number of load and export operations are already running on the Teradata Database. |
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_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 to use for tracing messages. The default setting creates a new file name with the name of the driver followed by a time stamp. Note: If a file with the specified name already exists then the file will be overwritten. |
TD_WORKINGDATABASE |
varchar |
Specifies the name of the database used in a Teradata SQL DATABASE statement that the Stream 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. |