getUDFOutputClob() - Advanced SQL Engine - Teradata Database

SQL External Routine Programming

Product
Advanced SQL Engine
Teradata Database
Release Number
17.05
17.00
Published
June 2020
Language
English (United States)
Last Update
2021-01-24
dita:mapPath
qwr1571437338192.ditamap
dita:ditavalPath
lze1555437562152.ditaval
dita:id
B035-1147
lifecycle
previous
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.

Return Value

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