Purpose
Write Checkpoint Record is the service function that writes a checkpoint record to the restart log file.
Structure
#include <pxoper.h> PXSTC_Code PX_WriteCheckpoint(PX_OperatorHandle operator, PX_Addr dataAddr, PX_Length dataLength);
where the following is true:
| Parameter | Function | Specification |
|---|---|---|
| dataAddr | input | Address of the checkpoint record to be written. |
| dataLength | input | Length of the checkpoint record. |
| operator | input | Operator handle from which the checkpoint record is to be read. |
Return Codes
The following Write 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 write of the checkpoint record. |
Usage Notes
Consider the following when defining the Write Checkpoint Record function.
| Topic | Usage Notes |
|---|---|
| Status | If the function status is PXSTC_Success, then the checkpoint record is written to the restart log table. See also the Read Checkpoint Record function. |