Purpose
Finalize Table Schema Definition is the service function that finalizes the process of creating the table schema.
Structure
#include <pxoper.h>
PXSTC_Code PX_FinalizeTableSchemaDefinition(PX_TableSchemaHandle tableSchemaHandle);
where the following is true:
| Parameter | Function | Specification |
|---|---|---|
| tableSchemaHandle | input | Table schema handle function to be finalized. |
Return Codes
The following Finalize Table Schema Definition function status codes are defined by the Teradata PT operator interface.
| Status Code | Signifies |
|---|---|
| PXSTC_Conflict | Mismatching type of operations, data, or protocols. |
| PXSTC_CountError | The specified number of objects does not match some pre-defined value. |
| PXSTC_LengthError | The length of the data to be stored does not match the length of the internal buffer. |
| PXSTC_BadHandle | An undefined table schema handle. |
| PXSTC_SchemaError | An error was detected in the data schema. |
| PXSTC_Success | Successful creation of the table schema. |
Usage Notes
Consider the following when using the Finalize Table Schema Definition function.
| Topic | Usage Notes |
|---|---|
| Description | Use the Finalize Data Schema Definition function to finalize a data schema before it can be used by Teradata PT operators for subsequent data manipulation functions. |
| Status | If the function status is PXSTC_Success, the defined table schema can be used by Teradata PT operators. See also Begin Table Schema Definition. |