15.10 - Specification of Operator Attributes - Parallel Transporter

Teradata Parallel Transporter User Guide

prodname
Parallel Transporter
vrm_release
15.10
category
User Guide
featnum
B035-2445-035K

Specification of Operator Attributes

The specification of operator attributes in a DEFINE OPERATOR statement identifies the attributes that require specified values or that must use other than default attribute values.

Attribute specification requires two actions; declaring attributes and assigning attribute values.

Declaring Attributes

The following rules describe how to declare attributes in a DEFINE OPERATOR statement:

  • Attributes must be declared in the operator definition when:
  • they are required by the operator.
  • you want to assign a value that is different than the default attribute value.
  • you want the option of assigning an overriding value (for either the default or assigned value) in the APPLY statement.
  • Declaring an attribute requires that you list the attribute name under ATTRIBUTES in the operator definition as follows:
  • ATTRIBUTES 
    (
       VARCHAR TraceLevel,
       VARCHAR TenacityHours=0,
       VARCHAR PrivateLogName=’export.log’,
       VARCHAR SelectStmt,
    );

    Note: The use of VARCHAR and INTEGER is optional when the attribute declaration includes a value assignment, such as for TenacityHours and PrivateLogName, above.

  • All required attributes must be declared. Note that most attributes are not required.
  • Optional attributes automatically assume their default attribute values. If the default value for an optional attribute is adequate for the purpose of a job, it need not be declared.
  • Note: Not all attributes have default values.

    For information on operator attributes and default values, see the chapters on individual operators in the Teradata Parallel Transporter Reference.

    Assigning Attribute Values

    The following rules describe how to assign attribute values to attributes declared in a DEFINE OPERATOR statement:

  • Assign values to attributes in the DEFINE OPERATOR statement if:
  • There is no default value, such as for the UserName and UserPassword attributes.
  • The job cannot use the default value and you do not want to assign a value in the APPLY statement that references the operator.
  • Do not assign values for declared attributes if:
  • The operator uses the default attribute value; for example, the default On (enabled) for the Stream operator ArraySupport attribute.
  • The APPLY statement that references the operator assigns an attribute value.
  • Note: If an attribute value is assigned in the operator definition and is also assigned in the APPLY statement, the APPLY value overrides the value in the operator definition. The override value applies only to the occurrence of the operator where the override value is assigned. All other occurrences in the script are unaffected. For further information, see “Attribute Value Processing Order” on page 63.

  • The value assigned to an attribute (anywhere in the script) is a job variable, using the form attributeName = @<jobVariableName> , then the variable will be replaced by the value from the highest priority job variable source.
  • For further information on setting job variables and the processing order of job variable sources, see “Specifying Job Variables for Attribute Values” on page 63.

  • The value assigned to an attribute must match the data type of the attribute.