16.20 - getObject(int objNum) - 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)

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

Argument

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 Teradata Database. The UDF uses the data during the Phase.AGR_COMBINE aggregation phase.

Return Value

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

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