16.20 - getNumDimensions() - 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 the number of dimensions defined for a given Array. Possible values correspond to the number of dimensions supported for Teradata ARRAY types. This method supports both 1-D and N-D arrays.

Syntax

int getNumDimensions()
                       throws SQLException

Return Value

An int value containing the number of dimensions defined for the given Array type.

Exceptions

Throws SQLException if an error occurs while attempting to access the array. A database specific code “9743 (ERRUDFJAVARRAY) <Failed to retrieve number of Array dimensions>” is returned.