Teradata® Parallel Transporter Reference | DEFINE OPERATOR | Syntax - Syntax - Parallel Transporter

Teradata® Parallel Transporter Reference - 20.00
Deployment
VantageCloud
VantageCore
Edition
IntelliFlex
Enterprise
VMware
Lake
Product
Parallel Transporter
Release Number
20.00
Published
October 2023
ft:locale
en-US
ft:lastEdition
2025-04-02
dita:mapPath
mjn1691132485167.ditamap
dita:ditavalPath
obe1474387269547.ditaval
dita:id
ogv1478610452101
Product Category
Teradata Tools and Utilities

The DEFINE OPERATOR syntax order is important.











where:

Syntax Element Description
attributeName The name of an attribute that is meaningful to the operator being defined.

For example, the value of the attribute name supplies the operator with required information, invokes an optional operator feature, or otherwise helps to direct the activities of the operator during job execution.
ATTRIBUTES

ATTR

 Required keyword introducing a list of attribute declarations for the defined operator object.

For information on available attributes and required syntax see the topics describing the individual operators, beginning with DataConnector Operator.
attribute declaration list Required. Excerpt representing a list of the attribute declarations for the operator object.
Observe the following when declaring attributes:
  • All predefined Teradata PT operators have some required attributes, all of which must be declared.
  • Optional attributes for predefined Teradata PT operators automatically use default attribute values unless alternate values are specified.
  • Declare optional attributes only if you want to assign values to those attribute that do not have defaults, or to change the default values, either in the operator definition, or in a later section of the job script, such as an APPLY statement.

For detailed strategy on how to determine the most useful locations for assigning attribute values “Declaration of Operator Attributes” in Teradata Parallel Transporter User Guide (B035-2445).

For the attribute descriptions and syntax the topics describing the individual operators, beginning with DataConnector Operator.
DEFINE OPERATOR Required keyword phrase specifying the beginning of the operator definition.
DESCRIPTION 'descriptionString' Optional keyword phrase providing a descriptive comment about the defined operator object.
EXTERNAL NAME 'operatorFileName' Keyword phrase indicating the actual name of a generic or custom operator library file.

This attribute is required if specifying a generic or custom operator type (for example, TYPE CONSUMER), and not required if specifying a standard, predefined operator type (for example, TYPE STREAM).
integerValue An integer that is a valid value of the operator attribute being declared: INTEGER type attribute attributeName.
operatorObjectName Required internal Teradata PT metadata name of the defined operator object.
standard operator specification Excerpt representing a list of the standard operator type specifications for the TYPE specification.
Specify one of the following:
  • DATACONNECTOR PRODUCER
  • DATACONNECTOR CONSUMER
  • DDL
  • EXPORT
  • FASTEXPORT OUTMOD
  • FASTLOAD INMOD
  • INSERTER
  • LOAD
  • MULTILOAD INMOD
  • MULTILOAD INMOD FILTER
  • ODBC
  • OS COMMAND
  • SCHEMAMAPPER
  • SELECTOR
  • STREAM
  • UPDATE
  • UPDATE STANDALONE
stringValue A character string that is a valid value of the operator attribute being declared: VARCHAR type attribute attributeName.
generic operator specification Excerpt representing a list of the generic operator type specifications for the TYPE specification.

Specify one of the following depending on how the operator functions:

  • Producer: specifies that the defined operator object is of type producer, meaning that it may retrieve data from an external data store such as a file or database table, and provides it to other operators.
  • Consumer: specifies that the defined operator object is of type consumer, meaning that it accepts data from other operators and may store it in an external data store such as a file or database table.
  • Standalone: specifies that the defined operator does not exchange data with other operators.
  • Filter: specifies that the defined operator object will perform filtering on data en route from other operators.

If one of these generic custom operator types is specified, then EXTERNAL NAME is also required.
SCHEMA schemaName

SCHEMA *

 Keyword phrase identifying a Teradata PT schema, previously defined in the job script, or *, deferring schema identification until run time.

Observe the following operator schema requirements:

  • Producer operators must specify a schema.
  • Consumer operators must specify SCHEMA* (“deferred” schema), meaning that the consumer operator uses the schema that the producer operator uses. The schema is passed to the consumer operator during job execution.
  • Standalone operators must not specify a schema.
  • Filter operators must specify both an input and an output schema.
TYPE Required keyword specifying the type of operator object to be used in the job.

Using the form TYPE <operator specification> specify a standard, predefined operator, or a generic operator.

  • a predefined operator from the list shown here in “predefined operator specification”

    or

  • a generic operator from the list shown in “generic operator specification”
A schema specification is required except for standalone operators.