getXSPInoutArrayForNull(int) - Analytics Database - Teradata Vantage

SQL External Routine Programming

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
VMware
Product
Analytics Database
Teradata Vantage
Release Number
17.20
Published
June 2022
Language
English (United States)
Last Update
2023-07-11
dita:mapPath
iiv1628111441820.ditamap
dita:ditavalPath
qkf1628213546010.ditaval
dita:id
B035-1147
lifecycle
latest
Product Category
Teradata Vantageā„¢

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.

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.

Syntax

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

Syntax Elements

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.