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

Read Checkpoint Record is the service function that reads a checkpoint record.

Structure

#include <pxoper.h>
PXSTC_Code PX_ReadCheckpoint(PX_OperatorHandle  operator,
   PX_Addr *  dataAddr,
   PX_Length *  dataLength);

where the following is true:

Parameter Function Specification
dataAddr output Pointer to the address of the checkpoint record.
dataLength output Pointer to the length of the checkpoint record.
operator input Operator handle from which the checkpoint record is to be read.

Return Codes

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

Status Code Signifies
PXSTC_InvalidArgument One or more bad input arguments.
PXSTC_BadHandle An undefined operator handle.
PXSTC_Success Successful read of the checkpoint record.

Usage Notes

Consider the following when defining the Read Checkpoint Record function.

Topic Usage Notes
Status If the function status is PXSTC_Success, then the checkpoint record is stored in the location pointed to by the dataAddr parameter. See also the Write Checkpoint Record function.