17.00 - Checkpoint - 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

Checkpoint is a user-provided function that creates a checkpoint record for operators.

Structure

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

where the following is true:

Parameter Function Specification
operator input Operator handles associated with the Checkpoint function.
phase input Current processing phase number

Return Codes

The following Checkpoint function status codes are defined by the Teradata PT operator interface.

Status Code Signifies
PXSTC_EndMethod Successful checkpoint processing.

This status condition indicates that the checkpoint record was successfully written to the restart log by this function.

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

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

Usage Notes

Consider the following when using the Checkpoint function.

Topic Usage Note
Description Use the Checkpoint function to record the checkpoint information identified by the operator parameter. See also the Restart function.