getObject(int objNum) - Advanced SQL Engine - Teradata Database

SQL External Routine Programming

Product
Advanced SQL Engine
Teradata Database
Release Number
17.10
Published
July 2021
Language
English (United States)
Last Update
2021-07-27
dita:mapPath
rin1593638965306.ditamap
dita:ditavalPath
rin1593638965306.ditaval
dita:id
B035-1147
lifecycle
previous
Product Category
Teradata Vantage™

Returns data that was stored in one of two intermediate aggregate storage areas.

If the specified storage area contains no data, getObject() returns a null object.

Syntax

getObject(int objNum)

Syntax Elements

objNum
The objNum input argument specifies which aggregation storage area to retrieve intermediate results from.
Value Meaning
1 Retrieve intermediate results from the first aggregate storage area.

The data that the UDF retrieves was stored from a call to Context.setObject() during a previous aggregation phase. The UDF uses the previously stored data during the Phase.AGR_DETAIL, Phase.AGR_COMBINE and Phase.AGR_FINAL aggregation phases.

2 Retrieve intermediate results from the second aggregate storage area.

The data that the UDF retrieves is stored by Vantage. The UDF uses the data during the Phase.AGR_COMBINE aggregation phase.

Exceptions

If the value of objNum is out of range, getObject() throws an SQLException to indicate that the input parameter of Context.getObject(int) is out of range, setting the SQLException fields as follows.

SQLState Field vendorCode Field
“TS000” 7844