16.20 - FNC_GetDatasetInputLob - Advanced SQL Engine - Teradata Database

Teradata Vantage™ - SQL External Routine Programming

Product
Advanced SQL Engine
Teradata Database
Release Number
16.20
Release Date
April 2020
Content Type
Programming Reference
Publication ID
B035-1147-162K
Language
English (United States)

Purpose

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  )
DATASET_HANDLE datasetHandle
A handle to a DATASET data type instance that is defined to be an input parameter to an external routine.
LOB_LOCATOR* 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.