16.10 - Get Table Schema List - Parallel Transporter

Teradata Parallel Transporter Operator Programmer Guide

prodname
Parallel Transporter
vrm_release
16.10
created_date
May 2017
category
Programming Reference
featnum
B035-2435-057K

Purpose

Get Table Schema List is the service function that retrieves the table schemas associated with an operator.

Structure

#include <pxoper.h>
PXSTC_Code PX_GetTableSchemaList(
   PX_OperatorHandle  operator,
   PX_SchemaType  schemaType,
   PX_TableSchemaList *  tableSchemaList,
   PX_Count *  tableSchemaCount);

where the following is true:

Parameter Function Specification
operator input Operator handle from which the list of table schemas is to be retrieved.
schemaType input Schema type, which can be either:
  • PX_InputSchema
  • PX_OutputSchema
  • PX_InputOutputSchema
tableSchemaList output Pointer to the address of the list of table schemas.
tableSchemaCount output Pointer to the number of schemas in the table schema list.

Return Codes

The following Get Table Schema List 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_NotFound The specified table list was not found in the specified object.
PXSTC_Success Successful fetching of the table schema list.

Usage Notes

Consider the following when defining the Get Table Schema List function.

Topic Usage Notes
Status If the function status is PXSTC_Success:
  • The address of the table schema list is stored at the location indicated by the tableSchemaList parameter.
  • The tableSchemaCount parameter points to the number of table schemas in the list.
See Also