FNC_GetDatasetSchemaLob Function | C Library Functions | Teradata Vantage - 17.10 - FNC_GetDatasetSchemaLob - 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)

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

Syntax

Void
FNC_GetDatasetSchemaLob( DATASET_HANDLE   datasetHandle,
                         LOB_LOCATOR*               schemaLoc,
                         dataset_schema_encoding_t  schemaEncoding)

Syntax Elements

datasetHandle
A handle to a DATASET type instance that is defined to be an input parameter to an external routine.
schemaLoc
A pointer to a LOB_LOCATOR that will be used to read the LOB schema of a DATASET type instance.
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.