FNC_GetDatasetInfo Function | C Library Functions | Teradata Vantage - 17.10 - FNC_GetDatasetInfo - Advanced SQL Engine - Teradata Database

Teradata Vantageā„¢ - SQL External Routine Programming

Product
Advanced SQL Engine
Teradata Database
Release Number
17.10
Release Date
July 2021
Content Type
Programming Reference
Publication ID
B035-1147-171K
Language
English (United States)

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)

Syntax Elements

datasetHandle
A handle to a DATASET data type instance that is defined to be an input parameter to an external routine.
maxLength
Return parameter.

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

inLineLength
Return parameter.

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

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.

rawDataLength
Return parameter.

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

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.

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.

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.