where:
Syntax Element | Description |
---|---|
AccountId = 'acctId' | Optional attribute that specifies
the account associated with the user name. If omitted, it defaults to the account identifier of the immediate owner database. |
AmpCheck = 'option' | Optional attribute that specifies
the Update operator response to a down AMP condition:
All of the target tables in the Update
operator job must be fallback tables for the job to start, restart,
or continue with a down AMP. The job does not start or restart if
any of the target tables are nonfallback.
|
BufferSize = KBytes | Optional attribute that specifies the output buffer size, in kilobytes, that is used for sending Update parcels to the database. The output buffer size and the size of the rows in the Update table determine the maximum number of rows that can be included in each parcels to the database. A larger buffer size reduces processing overhead by including more data in each parcels. Allowable values are 1 through 16384, but if you specify a value of 16384, the actual buffer size gets set to 16775552 bytes, which is less than the full 16MB. If the value less than 1, an error message results and job terminates. The default buffer size is 1024K bytes when the operator is talking to a Teradata Database 16.00 or later. The default buffer size is 64K bytes when the operator is talking to a pre-16.00 Teradata Database version. The maximum allowed buffer size is usually 16384 Kbytes. Values are evaluated when the connection to the database is made. If the supplied buffer size is too large, the operator scales it back to the maximum allowed buffer size. |
CheckpointRowCount - ‘option’ | Optional attribute that tells the Update operator to enable or disable outputting the rows sent at checkpoints. Valid values are:
This attribute is only available in the TPT script mode. |
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 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 Update operator job, where:
|
DeleteLobDataFiles = 'option' | Optional attribute that specifies whether to delete deferred LOB data files from the Data Connector Producer once the rows are committed to the database. Valid values for 'option' are:
Specifying any other value results in an error. |
DeleteTask = 'option' | Optional attribute that specifies whether to perform the delete task that deletes data from a single database table. The Delete Task deletes rows much more quickly than a plain DELETE SQL statement. You cannot use a delete task on a view. The valid values for option are:
Specifying any other value results in an error. The absence of any value is the same as a 'No' value, that is, the Update operator will execute an IMPORT task, and none of these rules apply. If the DeleteTask attribute processing is enabled, the only other optional attributes with any importance are:
|
DeleteTempLobFiles | Optional attribute that tells the operator whether or not to delete the temporary LOB directory and the temporary LOB files in the directory at cleanup. Valid values are:
When the temporary LOB files exist in a remote NFS mount directory, the suggestion is to set this attribute to 'No' and the operator will not spend time deleting the temporary LOB files.
Temporary LOB files will be created in the temporary LOB directory.
The naming convention for the temporary LOB directory will be as follows:
This attribute is not supported in TPTAPI. This attribute is not supported on z/OS. |
DropErrorTable = ‘option’ | Optional attribute that specifies whether or not error tables are dropped upon successful completion of the update job, even if the error tables are empty. Valid values are:
|
DropLogTable = ‘option’ | Optional attribute that specifies whether or not restart log table is dropped upon successful complete of the load job. Valid values are:
|
DropWorkTable = ‘option’ | Optional attribute that specifies whether or not the work tables are dropped upon successful completion of the load job. Valid values are:
|
ErrorLimit = limit | Optional attribute that specifies the approximate number of records that can be stored in one of the error tables before the Update operator job is terminated. This number is approximate because the Update operator sends multiple rows of data at a time to the database. By the time the Update operator processes the message indicating that the error limit has been exceeded, it may have loaded more records into the error table than the actual number specified in the error limit. The ErrorLimit specification must be greater than 0. Specifying an invalid value will cause the Update operator job to terminate. By default, ErrorLimit value is unlimited. The ErrorLimit specification applies to each instance of the Update operator. |
ErrorTable1 = 'eerrorTable1Name' | Optional attribute that specifies
the name of the first error table, called the acquisition error
table. This table contains information about data errors that occur
during the acquisition phase of the Update operator job. 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 Update operator job. If the name is not supplied, it is created by the Update operator. The name of the created table is prepended with an identifying ttname_ET, thus ensuring uniqueness (for example ttname_ETif VARCHAR is used, orttname1_ET, ttname2_ET,..., ttname5_ET, if VARCHAR ARRAY is used). For more information, see ErrorTable and Auto-Generation of Error and Work Tables. |
ErrorTable2 = 'errorTable2Name' | Optional attribute that specifies
the name of the second error table, called the application error
table. This table contains information about data errors that occur
during the application phase of the Update operator job. This must be a new table name. Do not use a name that duplicates the name of an existing table unless you are restarting an Update operator job. If the name is not supplied, it is created by the Update operator. The name of the created table is prepended with an identifying ttname_UV, thus ensuring uniqueness (for example tname_UVif VARCHAR is used, orttname1_UV, ttname2_UV, …, ttname5_UV, if VARCHAR ARRAY is used). For more information, see ErrorTable and Auto-Generation of Error and Work Tables. |
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:
|
LogTable = 'logTableName' | Optional attribute that specifies the name of the restart log table that stores checkpoint information for restarting a job. If running a new job, specify a new table name that is different from the name of any existing table. The Update operator then creates a new restart log table. If restarting a paused job, then the restart log table must exist, and the Update operator restarts the job from the last checkpoint. The restarted job will continue using the existing restart log table. When a job successfully completes, the operator drops the restart log table. Failure to specify a restart log table will cause the job to terminate. The following privileges are required on the restart log table:
The following privileges are required on the database that contains the restart log table:
The Update operator automatically maintains the restart log table. Manipulating the restart log table in any way invalidates the restart capability. If the restart log table name is not fully qualified, it is created under the user's default (logon) database. If the WorkingDatabase attribute is used, you MUST fully qualify the restart log table name, even if the restart log table is going to reside in the default (logon) database. |
MaxSessions = maxSessions | Optional attribute that specifies
the maximum number of sessions to log on. The MaxSessions value must be greater than 0. Specifying a value less than 1 terminates the job. The default is one session per available AMP. The maximum value cannot be more than the number of AMPS available. The main instance calculates an even distribution of the Update operator sessions among the number of instances. For example, if there are 4 instances and 16 Update operator sessions, then each instance will log on four Update operator sessions. |
MinSessions = minSessions | Optional attribute that specifies
the minimum number of sessions required for the Update operator job
to continue. The MinSessions value must be greater than 0 and less than or equal to the maximum number of Update operator sessions. Specifying a value less than 1 (the default) terminates the job. |
NotifyExit = 'inmodName' | Attribute that specifies the name
of the user-defined notify exit routine with an entry point named
_dynamn. If no value is
supplied, the following default name is used:
See Deprecated Syntax for information about providing your own notify exit routine. |
NotifyExitIsDLL = 'option' | Optional attribute (for z/OS
systems only) that specifies whether the notify exit routine is
built as a DLL (shared library) or not. Valid values are:
Specifying any other value terminates the job. |
NotifyLevel='notifyLevel' | Optional attribute that specifies
the level at which certain events are reported. The valid values
are:
|
NotifyMethod = 'notifyMethod' | Optional attribute that specifies
the method to be used for reporting events. The methods are:
|
NotifyString = 'notifyString' | Optional attribute that specifies 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:
|
Pack = number | Optional attribute that specifies the pack factor for the job. Valid values are 1 through 16383. The default value is 16383. The pack factor applies only when the job uses the Extended MultiLoad Protocol. The pack factor tells the Update operator how many data records to include with the Array Insert statement. The Array Insert statement is sent to the database during the job acquisition phase. When the job is loading 1 or more deferred LOB columns, the largest possible pack factor is 4096 because the database can support up to 4096 spool files per request.
|
PauseAcq = 'option' | Optional attribute that specifies
whether to pause the Update operator job after the acquisition phase
or enter the application phase. The values are:
Specifying any other value terminates the job. The absence of any value for the PauseAcq attribute means that the Update operator job will execute both the acquisition phase and the application phase without pausing. |
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 Update 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 Update operator PrivateLogName attribute: tlogview -j jobid -f privatelogname By default, no diagnostic trace messages are produced. Diagnostic trace messages are produced only when the user sets a valid value for the TraceLevel attribute. If the private log is not specified, all of 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 Update Operator private log. Use of the QueryBandSessInfo attribute is subject to the following rules:
|
ReplicationOverride =' option' | Optional attribute that overrides the normal replication services controls for an active session. Valid values:
For more information, see Teradata Replication Services Using Oracle GoldenGate (B035-1152). The user ID that is logged in by the operator must have the REPLCONTROL privilege when setting the value for this attribute.
|
RoleName = 'role name' |
Optional attribute that implements security in the database. 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 main control session and the auxiliary SQL session after the sessions are connected. The operator does not send the request on the MultiLoad protocol sessions, because the database does not allow the request to be sent on the MultiLoad protocol sessions. The operator uses the MultiLoad protocol sessions when the job uses the traditional MultiLoad protocol. When the job uses the extended MultiLoad protocol, the operator will send the request to the database on the data SQL sessions after the sessions are connected.
|
TargetTable = 'targetTableName' | Required attribute that specifies
the name of the Update target table to receive data from the client
system. The table must already exist. |
VARCHAR TASMFASTFAIL = 'value' | Optional attribute that enables FASTFAIL feature. Valid values are:
|
TenacityHours = hours | Optional attribute that specifies the number of hours that the Update operator continues trying to log on when the maximum number of load/unload operations are already running on the database. The default value is 4 hours. To enable the tenacity feature, the hours value must be greater than 0. Specifying a value of 0 disables the tenacity feature. Specifying a value of less than 0 terminates the Update job. |
TenacitySleep = minutes | Optional attribute that specifies the number of minutes that the Update job pauses before retrying a logon operation when the maximum number of load/export operations are already running on the database. The minutes value must be greater than 0. If you specify a value less than 1, the Update operator responds with an error message and terminates the job. The default is 6 minutes. |
TdpId = 'dbcName' | Optional attribute that specifies the name of the database machine (non-mainframe platforms) or TDP (mainframe platforms) for the Update 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. |
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 main control and auxiliary SQL sessions after the sessions are connected. The operator does not send the request on the MultiLoad protocol sessions, because the database does not allow the request to be sent on the MultiLoad protocol sessions. The operator uses the MultiLoad protocol sessions when the job uses the traditional MultiLoad protocol. When the job uses the Extended MultiLoad Protocol, the operator will send the request to the database on the data SQL sessions after the sessions are 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 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 changes 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. The operator will send the request to the database on the main control SQL session after the session is connected. The operator does not send the request on the MultiLoad protocol sessions, because the database does not allow the request to be sent on the MultiLoad protocol sessions. The operator uses the MultiLoad protocol sessions when the job uses the traditional MultiLoad protocol. Furthermore, the operator does not send the request on the auxiliary SQL session when the job uses the traditional MultiLoad protocol, because the database does not require it. When the job uses the Extended MultiLoad Protocol, the operator will send the request to the database on the data SQL and auxiliary SQL sessions after the sessions are connected.
|
TreatDBSRestartAsFatal = 'option' | Optional attribute that tells the operator whether or not 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 load data with Unicode pass through characters.
|
UserName = 'userId' | Attribute that specifies the 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
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.
|
WorkTable = 'workTable' | Optional attribute that specifies the name of the work table. This must be a new table name that does not duplicate the name of any existing table, unless you are restarting a paused Update operator job. If the name is not supplied, it is created by the Update operator. The name of the created table is prepended with an identifying ttname_WT, thus ensuring uniqueness (for example, ttname_WT if VARCHAR is used, or ttname1_WT, ttname2_WT, …, ttname5_WT, if VARCHAR ARRAY is used).
When the job has multiple work tables and uses the Extended MultiLoad Protocol, only the first work table is created. The Update operator inserts records into the first work table during the acquisition phase.
|
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. |