16.20 - FNC_GetDatasetInfo - Advanced SQL Engine - Teradata Database

Teradata Vantage™ - SQL External Routine Programming

Product
Advanced SQL Engine
Teradata Database
Release Number
16.20
Release Date
April 2020
Content Type
Programming Reference
Publication ID
B035-1147-162K
Language
English (United States)

Purpose

Retrieves information about a particular DATASET data type instance, such as the maximum length, inline length, and storage format.

Syntax

void
FNC_GetDatasetInfo ( DATASET_HANDLE       datasetHandle,
                     int*                 maxLength,
                     int*                 inLineLength,
                     int*                 schemaLength,
                     int*                 rawDataLength,
                     dataset_storage_et*  storageFormat,
                     boolean_t*           dataLob,
                     boolean_t*           schemaLob)
DATASET_HANDLE datasetHandle
A handle to a DATASET data type instance that is defined to be an input parameter to an external routine.
int* maxLength
Return parameter.

Specifies the maximum possible length of this DATASET data type instance in bytes.

int* inLineLength
Return parameter.

Specifies the inline length of this DATASET data type instance in bytes.

int* schemaLength
Return parameter.

Specifies the length of the schema for this DATASET data type instance in terms of the number of bytes in the UTF-8 encoding.

int* rawDataLength
Return parameter.

Specifies the length of the data for this DATASET data type instance.

dataset_storage_et* storageFormat
Return parameter.

Specifies the storage format of this DATASET data type instance based on the dataset_storage_et enumerated type defined in sqltypes_td.h.

boolean_t* dataLob
Return parameter.

If this DATASET type instance stores its value as a LOB, this will be set to 1. Otherwise this value will be set to 0.

boolean_t* schemaLob
Return parameter.

If this DATASET type instance stores its schema as a LOB, this will be set to 1. Otherwise this value will be set to 0.