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

Purpose

Creates a new instance of com.teradata.fnc.Array when a NULL is passed in as the INOUT parameter of a Java external stored procedure.

  • This method is supported for both 1-D and N-D arrays. However, this method is provided mainly for support of N-D arrays because the com.teradata.fnc.Array class provides some additional method signatures especially for N-D arrays. For 1-D arrays, it is recommended to use any generic implementation of java.sql.Array instead, because 1-D array support conforms to the JDBC standard.
  • This method is a Teradata extension.

Syntax

com.teradata.fnc.Array getXSPInoutArrayForNull(int  param_index)
                            throws Exception

Parameters

param_index
The index of the particular INOUT parameter as it appears in the list of parameters for the Java external stored procedure, starting from 0.

Return Value

A new object of type com.teradata.fnc.Array.

The new com.teradata.fnc.Array object is initialized with the type information provided for the INOUT parameter of the external stored procedure.

If the array is defined as DEFAULT NULL, the new com.teradata.fnc.Array object will have all its elements initialized to NULL. Otherwise, no elements are initialized.