Required and Optional Attributes - Parallel Transporter

If omitted, it defaults to the account identifier of the immediate owner database.

The output buffer size and the size of the rows in the Load 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.

This attribute is only available in the TPT script mode.

For information on connection string, see Teradata® Call-Level Interface Version 2 Reference for Workstation-Attached Systems, B035-2418.

• 'integerDate' = the integer DATE data type (default)
• 'ansiDate' = the ANSI fixed-length CHAR(10) DATE data type

The ErrorLimit specification must be greater than 0. Specifying an invalid value will cause the Load operator to terminate. By default, ErrorLimit value is unlimited.

The ErrorLimit specification applies to each instance of the Load operator.

• Data conversion errors
• Constraint violations
• AMP configuration changes

These types of errors always occur during the acquisition phase of the Load operator job.

ErrorTable1 must be a new table name. Do not use a name that duplicates the name of an existing table unless you are restarting a paused Load operator job.

The default name for ErrorTable1 is ttname_ET.

For more information, see ErrorTable1 and Auto-Generation of Error Tables.

ErrorTable2 must be a new table name. Do not use a name that duplicates the name of an existing table unless you are restarting a Load operator job.

The default name for ErrorTable2 is ttname_UV.

For more information, see ErrorTable2 and Auto-Generation of Error Tables.

If running a new job, specify a new table name that is different from the name of any existing table). The Load operator then creates a new restart log table.

If restarting a paused job, then the restart log table must exist, and the Load 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.

Users must also have DROP and CREATE privileges on the database that contains the restart log table.

The Load 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.

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 exceed the number of available AMPS.

The MinSessions value must be greater than 0 and less than or equal to the maximum number of Load operator sessions. Specifying a value less than 1 (the default) terminates the job.

• libnotfyext.dll for Windows platforms
• libnotfyext.dylib for the Apple macOS platform
• libnotfyext.so for all other UNIX platforms
• NOTFYEXT for z/OS platforms

See Deprecated Syntax for information about providing your own notify exit routine.

• 'Yes' (or 'Y') = notify exit routine is built as a DLL (default).
• 'No' or ('N') = notify exit routine is not built as a DLL.

Any other value terminates the job.

• 'Off' = no notification of events is provided (default)
• 'Low' = 'Yes' in the Low Notification Level column
• 'Med' = 'Yes' in the Medium Notification Level column
• 'High' = 'Yes' in the High Notification Level column

• 'None' = no event logging is done (default).
• 'Msg' = sends the events to a log.

  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 Solaris, AIX, and Linux platforms, the destination of the events is dependent upon the setting specified in the /etc/syslog.conf file.

  On SLES11, the destination of the events is dependent upon the setting specified in the /etc/syslog-ng.conf file.

  On z/OS systems, events are sent to the job log.

• 'Exit' = sends the events to a user-defined notify exit routine. Row count information is in 4-byte unsigned integer values.
• 'Exit64' = sends the events to a user-defined notify exit routine. Row count information is in 8-byte unsigned integer values for these events:

  NFEventCheckPoint64

  NFEventPhaseIEnd64

  NFEventPhaseIIEnd64

  NFEventDropErrTableI64

  NFEventDropErrTableII64

• 'ExitEON' = sends the events to a user-defined notify exit routine.

  Complete Teradata object names are passed to the notify exit routine for these events:

  NFEventInitializeEON

  NFEventPhaseIBeginEON

  In addition ExitEON sends row count information in 8-byte unsigned integer values.

• 80 bytes, if NotifyMethod is 'Exit'
• 16 bytes, if NotifyMethod is 'Msg'

• 'N[o]' for normal Load operator jobs, to distribute all of the rows that were sent to the database during the acquisition phase to their final destination on the AMPs (default).
• 'Y[es]' to pause after the completion of the acquisition phase and skip the application phase.

Specifying any other value terminates the job.

The absence of any value for the PauseAcq attribute means that the Load operator job will execute both the acquisition phase and the application phase without pausing. This will distribute all of the rows that were sent to the database during the acquisition phase to their final destination on the AMPs.

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’s PrivateLogName attribute:

tlogview -j  jobid  -f  privatelogname

If the private log is not specified, all output is stored in the public log.

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.

For more information about the tlogview command, see Teradata PT Utility Commands.

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 Load operator private log.

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 main control session and the auxiliary SQL session after the sessions are connected.

The operator does not send the request on the FastLoad protocol sessions, because the database does not allow the request to be send on the FastLoad protocol sessions.

A target table must already exist on a database and be empty, with no defined secondary or join indexes, before a Load job is run. You cannot use a name that duplicates the name of an existing table unless you are restarting a paused Load operator job.

For target tables defined as NoPI, the restriction that the target table must be empty does not apply.

The default value is 4 hours. To enable the tenacity feature, hours must be greater than 0. Specifying a value of 0 disables the tenacity feature. Specifying a value of less than 0 terminates the Load job.

The minutes value must be greater than 0. If you specify a value less than 1, the Load operator responds with an error message and terminates the job. The default is 6 minutes.

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.

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 FastLoad protocol sessions, because the database does not allow the request to be send on the FastLoad protocol sessions.

For more information on SET TIME ZONE SQL, see Teradata Vantage™ - SQL Data Definition Language Syntax and Examples, B035-1144.

• 'None' = TraceLevel turned off (default).
• 'CLI' = enables the tracing function for CLI-related activities (interaction with the database)
• 'PX' = enables the tracing function for activities related to the Teradata PT infrastructure
• 'Oper' = enables the tracing function for operator-specific activities
• 'Notify' = enables the tracing of activities related to the Notify feature
• 'All' = enables tracing for all of the above activities

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' ]

SET TRANSFORM GROUP FOR TYPE <udt name> <transform group name>;

"SET TRANSFORM GROUP FOR TYPE JSON CHARACTER SET LATIN TD_JSON_VARCHAR;"

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 main control session after the session is connected.

The operator does not send the request on the auxiliary SQL session, because the database does not require it.

The operator does not send the request on the FastLoad protocol sessions, because the database does not allow the request to be send on the FastLoad protocol sessions.

Use this attribute to load all of the columns in a table when the columns contain user-defined types (UDTs).

If you set this attribute to Yes when a valid, fully supported INSERT statement already exists, an error results.

A valid tableName matches the name of the table used in the TargetTable attribute and the semicolon is in the last non-whitespace character in the supplied DML statement as follows:

INS[ERT] [INTO] <tablename> ;