16.20 - FNC_GetDatasetSchemaLob - Advanced SQL Engine - Teradata Database

Teradata Vantage™ - SQL External Routine Programming

Advanced SQL Engine
Teradata Database
Release Number
Release Date
April 2020
Content Type
Programming Reference
Publication ID
English (United States)


Allows users to read the schema of a DATASET data type instance, which is stored as a LOB, using the LOB FNC routines.


FNC_GetDatasetSchemaLob( DATASET_HANDLE   datasetHandle,
                         LOB_LOCATOR*               schemaLoc,
                         dataset_schema_encoding_t  schemaEncoding)
DATASET_HANDLE datasetHandle
A handle to a DATASET type instance that is defined to be an input parameter to an external routine.
LOB_LOCATOR* schemaLoc
A pointer to a LOB_LOCATOR that will be used to read the LOB schema of a DATASET type instance.
dataset_schema_encoding_t schemaEncoding
The encoding in which the user would like to retrieve the schema.

Usage Notes

The schema is returned as UNICODE text, encoded in either UTF-8 or UTF-16, depending on the value of the schemaEncoding parameter.

Use FNC_GetDatasetSchemaLob when the schema is stored as a LOB. If FNC_GetDatasetInfo returns schemaLob > 0, you can use FNC_GetDatasetSchemaLob; otherwise, you should use FNC_GetDatasetSchema instead.