17.10 - Default Mapping Convention of Return Value Types - Advanced SQL Engine - Teradata Database

Teradata Vantageā„¢ - SQL External Routine Programming

Product
Advanced SQL Engine
Teradata Database
Release Number
17.10
Release Date
July 2021
Content Type
Programming Reference
Publication ID
B035-1147-171K
Language
English (United States)

Teradata uses the same mapping conventions for return value types that it uses for parameter types.

For a Java method that implements a scalar or aggregate UDF, the data type that you use for the return value maps to the SQL data type in the RETURNS clause of the CREATE FUNCTION or REPLACE FUNCTION statement. (Table UDFs do not have return values. The columns in the result rows that they produce are returned as output parameters.)

Consider the following CREATE FUNCTION statement for a scalar UDF:

CREATE FUNCTION factorial
  (x INTEGER)
RETURNS INTEGER
LANGUAGE JAVA
NO SQL
PARAMETER STYLE JAVA
RETURNS NULL ON NULL INPUT
EXTERNAL NAME 'JarUDF:UDFExample.fact';

The RETURNS clause specifies that the SQL data type of the return value is INTEGER. The signature of the fact method that implements the UDF looks like this:

public static int fact( int x ) { ... }

The default mapping convention is simple mapping, where SQL data types map to Java primitives. If no Java primitive can adequately map to an SQL type, then the default mapping convention is object mapping, where SQL data types map to Java classes.

Consider a factorial UDF that returns a DECIMAL value:

CREATE FUNCTION factorial
  (x INTEGER)
RETURNS DECIMAL(8,2)
LANGUAGE JAVA
NO SQL
PARAMETER STYLE JAVA
RETURNS NULL ON NULL INPUT
EXTERNAL NAME 'JarUDF:UDFExample.fact';

Because the DECIMAL type does not map adequately to a Java primitive, the DECIMAL type maps to java.math.BigDecimal. The signature of the fact method that implements the UDF looks like this:

public static BigDecimal fact( int x ) { ... }

For details on how SQL data types map to Java data types, see SQL Data Type Mapping.