getUDFOutputClob() - 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™

Retrieves the Clob object representing the return value of a Java UDF that returns a Clob. This method can only be called from a scalar or aggregate Java UDF. If called from an aggregate Java UDF, it may only be called in the Phase.AGR_FINAL execution phase. The character set of the Clob object returned by getUDFOutputClob() is the same as that of the Clob value that the caller returns.

A java.sql.Clob object representing the return Clob value of the Java UDF.

Exceptions

IF the caller is … THEN getUDFOutputClob() throws an SQLException to …
not a scalar or aggregate Java UDF indicate that the caller is not a scalar or aggregate Java UDF, setting the SQLException fields as follows:
  • SQLState Field = “TS000”
  • vendorCode Field = 7863
a UDF that does not return a Blob or Clob type indicate that the caller does not return a Blob or Clob, setting the SQLException fields as follows:
  • SQLState Field = “TS000”
  • vendorCode Field = 7862
a UDF that returns a Blob type indicate that the caller actually returns a Blob, setting the SQLException fields as follows:
  • SQLState Field = “TS000”
  • vendorCode Field = 7866
an aggregate Java UDF that returns a Clob, but the method is not called in the Phase.AGR_FINAL aggregation phase indicate that the method was called from an incorrect aggregation phase, setting the SQLException fields as follows:
  • SQLState Field = “TS000”
  • vendorCode Field = 7864