16.20 - FNC_GetXMLClob - 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

Returns a LOB locator for the CLOB representation of the XML type.

Syntax

void
FNC_GetXMLClob(XML_HANDLE    xmlHandle,
               LOB_LOCATOR *xmlClob)
XML_HANDLE xmlHandle
A handle to an XML type that is defined to be an input parameter to an external routine.
LOB_LOCATOR *xmlClob
The LOB locator for the CLOB representation of the XML type.

Usage Notes

FNC_GetXMLClob is used to get a LOB locator for the CLOB representation of the XML type. The CLOB will be in the UNICODE character set.

The XML handle xmlHandle is passed as input. The LOB locator value xmlClob is returned from the function. The user can then use LOB FNC routines to read from the xmlClob locator.

Note that the CLOB representation of the XML can contain XML data that is not well-formed.

FNC_GetXMLClob can only be used with LOB-based XML values, otherwise you will get an error.