FNC_GetDatasetInputLob Function | C Library Functions | Teradata Vantage - FNC_GetDatasetInputLob - 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
Language
English (United States)
Last Update
2023-07-11
dita:mapPath
iiv1628111441820.ditamap
dita:ditavalPath
qkf1628213546010.ditaval
dita:id
B035-1147
lifecycle
latest
Product Category
Teradata Vantageā„¢

This routine allows users to read DATASET data that is stored as a LOB using the LOB FNC routines.

Syntax

void
FNC_GetDatasetInputLob( DATASET_HANDLE   datasetHandle,
                        LOB_LOCATOR*     instance  )

Syntax Elements

datasetHandle
A handle to a DATASET data type instance that is defined to be an input parameter to an external routine.
instance
A pointer to a LOB_LOCATOR which will be used to read the LOB data of a DATASET instance.

Usage Notes

Use FNC_GetDatasetInputLob only when the DATASET data is stored as a LOB. If FNC_GetDatasetInfo returns dataLob > 0, you can use FNC_GetDatasetInputLob; otherwise, you should use FNC_GetInternalValue instead.

For Avro instances, this routine returns a LOB_LOCATOR which allows a user to access a buffer that contains the UTF-8 encoded schema, null-terminated, followed by the binary-encoded Avro value. This is equivalent to the transform format.

If the DATASET data is a CSV value, the value does not include any optional schema.