FNC_GetDatasetSchemaLob Function | C Library Functions | Teradata Vantage - FNC_GetDatasetSchemaLob - Analytics Database - Teradata Vantage

SQL External Routine Programming

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
VMware
Product
Analytics Database
Teradata Vantage
Release Number
17.20
Published
June 2022
ft:locale
en-US
ft:lastEdition
2025-03-30
dita:mapPath
iiv1628111441820.ditamap
dita:ditavalPath
qkf1628213546010.ditaval
dita:id
qnu1472247494689
lifecycle
latest
Product Category
Teradata Vantageā„¢

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 to use to read the LOB schema of a DATASET type instance.
schemaEncoding
The encoding in which the user wants 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, use FNC_GetDatasetSchemaLob. Otherwise, use FNC_GetDatasetSchema.