16.20 - getArray(long, 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

Retrieves a slice of the SQL ARRAY value designated by this Array object, beginning with the specified index and containing up to count successive elements of the SQL array.
  • Teradata only supports standard mapping.
  • This method is supported for 1-D arrays only.

Syntax

Object getArray(long  index,
                int  count)
                throws SQLException

Parameters

index
The array index of the first element to retrieve. The first element is at index 1.
count
The number of successive SQL array elements to retrieve.

Return Value

An array containing up to count consecutive elements of the SQL ARRAY value, beginning with element index.

Note that this routine may return less than count number of elements in the array. Any uninitialized elements in the array are not returned.

Exceptions

Throws SQLException in the following cases:

  • The method is called for an N-D array. A database specific code “9743(ERRUDFJAVARRAY)< <Method> cannot be called for N-D Arrays >” is returned.
  • An error occurs while attempting to access the array. A database specific code “9743 (ERRUDFJAVARRAY)<Failed to retrieve elements of the array>” is returned.