17.00 - Event - Parallel Transporter

Teradata® Parallel Transporter Operator Programmer Guide

prodname
Parallel Transporter
vrm_release
17.00
created_date
June 2020
category
Programming Reference
featnum
B035-2435-220K

Purpose

Event is a user-provided function that allows operators to perform event processing or notification.

Structure

#include <pxoper.h>
PXSTC_Code PX_Event(PX_OperatorHandle  operator, PX_LongInt  phase);

where the following is true:

Parameter Function Specification
operator input Operator handle that is associated with the Event function.
phase input Current processing phase number.

Return Codes

The following Event function status codes are defined by the Teradata PToperator interface.

Status Code Signifies
PXSTC_EndMethod Successful execution of the operator.

This status condition indicates that the event was successfully processed by this function.

PXSTC_NextPhase Proceed with the next processing phase.
PXSTC_SamePhase Continue with the current processing phase.

Define additional Event function status codes as required to support your operator.

Usage Notes

Consider the following when using the Event function.

Topic Usage Notes
Description This function requires the caller to user the PutAttribute function to specify the event to be processed by the operator.

Also see Put Attribute.