Class JdbcArray
Stay organized with collections
Save and categorize content based on your preferences.
JdbcArray
A JDBC Array. For documentation of this class, see java.sql.Array
.
Methods
| Method | Return type | Brief description |
free() | void | For documentation of this method, see
java.sql.Array#free(). |
getArray() | Object | For documentation of this method, see
java.sql.Array#getArray() |
getArray(index, count) | Object | For documentation of this method, see
java.sql.Array#getArray(long, int). |
getBaseType() | Integer | For documentation of this method, see
java.sql.Array#getBaseType(). |
getBaseTypeName() | String | For documentation of this method, see
java.sql.Array#getBaseTypeName(). |
getResultSet() | JdbcResultSet | For documentation of this method, see
java.sql.Array#getResultSet(). |
getResultSet(index, count) | JdbcResultSet | For documentation of this method, see
java.sql.Array#getResultSet(long, int). |
Detailed documentation
getArray()
For documentation of this method, see
java.sql.Array#getArray()
Return
Object — An object containing the ordered elements of the SQL array value.
getArray(index, count)
For documentation of this method, see
java.sql.Array#getArray(long, int).
Parameters
| Name | Type | Description |
index | Integer | The array index of the first element to retrieve, where the first element has an
index of 1. |
count | Integer | The number of successive SQL array elements to retrieve. |
Return
Object — An object containing up to the specified number of consecutive SQL array elements.
getBaseTypeName()
For documentation of this method, see
java.sql.Array#getBaseTypeName().
Return
String — The database-specific name for the built-in base type or else the fully-qualified SQL
type name for a base type that is a UDT.
getResultSet(index, count)
For documentation of this method, see
java.sql.Array#getResultSet(long, int).
Parameters
| Name | Type | Description |
index | Integer | The array index of the first element to retrieve, where the first element has an
index of 1. |
count | Integer | The number of successive SQL array elements to retrieve. |
Return
JdbcResultSet — A JdbcResultSet containing up to the specified number of consecutive SQL array
elements.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-03 UTC.
[null,null,["Last updated 2024-12-03 UTC."],[[["\u003cp\u003e\u003ccode\u003eJdbcArray\u003c/code\u003e provides methods to interact with SQL arrays within Apps Script.\u003c/p\u003e\n"],["\u003cp\u003eYou can retrieve array elements as an object or a \u003ccode\u003eJdbcResultSet\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eMethods are available to get the base type and name of the array elements.\u003c/p\u003e\n"],["\u003cp\u003eIt's based on the \u003ccode\u003ejava.sql.Array\u003c/code\u003e interface, and detailed documentation is linked for each method.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eJdbcArray\u003c/code\u003e allows freeing up resources associated with the array using the \u003ccode\u003efree()\u003c/code\u003e method.\u003c/p\u003e\n"]]],[],null,["# Class JdbcArray\n\nJdbcArray\n\nA JDBC `Array`. For documentation of this class, see [`java.sql.Array`](https://docs.oracle.com/javase/6/docs/api/java/sql/Array.html). \n\n### Methods\n\n| Method | Return type | Brief description |\n|--------------------------------------------------------------|--------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [free()](#free()) | `void` | For documentation of this method, see [` java.sql.Array#free()`](http://docs.oracle.com/javase/6/docs/api/java/sql/Array.html#free()). |\n| [getArray()](#getArray()) | `Object` | For documentation of this method, see [` java.sql.Array#getArray()`](https://docs.oracle.com/javase/6/docs/api/java/sql/Array.html#getArray()) |\n| [getArray(index, count)](#getArray(Integer,Integer)) | `Object` | For documentation of this method, see [`java.sql.Array#getArray(long, int)`](https://docs.oracle.com/javase/6/docs/api/java/sql/Array.html#getArray(long,%20int)). |\n| [getBaseType()](#getBaseType()) | `Integer` | For documentation of this method, see [` java.sql.Array#getBaseType()`](https://docs.oracle.com/javase/6/docs/api/java/sql/Array.html#getBaseType()). |\n| [getBaseTypeName()](#getBaseTypeName()) | `String` | For documentation of this method, see [` java.sql.Array#getBaseTypeName()`](https://docs.oracle.com/javase/6/docs/api/java/sql/Array.html#getBaseTypeName()). |\n| [getResultSet()](#getResultSet()) | [JdbcResultSet](/apps-script/reference/jdbc/jdbc-result-set) | For documentation of this method, see [` java.sql.Array#getResultSet()`](https://docs.oracle.com/javase/6/docs/api/java/sql/Array.html#getResultSet()). |\n| [getResultSet(index, count)](#getResultSet(Integer,Integer)) | [JdbcResultSet](/apps-script/reference/jdbc/jdbc-result-set) | For documentation of this method, see [`java.sql.Array#getResultSet(long, int)`](https://docs.oracle.com/javase/6/docs/api/java/sql/Array.html#getResultSet(long,%20int)). |\n\nDetailed documentation\n----------------------\n\n### `free()`\n\nFor documentation of this method, see [`\njava.sql.Array#free()`](http://docs.oracle.com/javase/6/docs/api/java/sql/Array.html#free()).\n\n*** ** * ** ***\n\n### `get``Array()`\n\nFor documentation of this method, see [`\njava.sql.Array#getArray()`](https://docs.oracle.com/javase/6/docs/api/java/sql/Array.html#getArray())\n\n#### Return\n\n\n`Object` --- An object containing the ordered elements of the SQL array value.\n\n*** ** * ** ***\n\n### `get``Array(index, count)`\n\nFor documentation of this method, see [`java.sql.Array#getArray(long, int)`](https://docs.oracle.com/javase/6/docs/api/java/sql/Array.html#getArray(long,%20int)).\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|-----------|----------------------------------------------------------------------------------------------|\n| `index` | `Integer` | The array index of the first element to retrieve, where the first element has an index of 1. |\n| `count` | `Integer` | The number of successive SQL array elements to retrieve. |\n\n#### Return\n\n\n`Object` --- An object containing up to the specified number of consecutive SQL array elements.\n\n*** ** * ** ***\n\n### `get``Base``Type()`\n\nFor documentation of this method, see [`\njava.sql.Array#getBaseType()`](https://docs.oracle.com/javase/6/docs/api/java/sql/Array.html#getBaseType()).\n\n#### Return\n\n\n`Integer` --- The [type\ncode](https://docs.oracle.com/javase/6/docs/api/java/sql/Types.html) for the elements in this array.\n\n*** ** * ** ***\n\n### `get``Base``Type``Name()`\n\nFor documentation of this method, see [`\njava.sql.Array#getBaseTypeName()`](https://docs.oracle.com/javase/6/docs/api/java/sql/Array.html#getBaseTypeName()).\n\n#### Return\n\n\n`String` --- The database-specific name for the built-in base type or else the fully-qualified SQL\ntype name for a base type that is a UDT.\n\n*** ** * ** ***\n\n### `get``Result``Set()`\n\nFor documentation of this method, see [`\njava.sql.Array#getResultSet()`](https://docs.oracle.com/javase/6/docs/api/java/sql/Array.html#getResultSet()).\n\n#### Return\n\n\n[JdbcResultSet](/apps-script/reference/jdbc/jdbc-result-set) --- The [JdbcResultSet](/apps-script/reference/jdbc/jdbc-result-set) containing one row for each of the elements in the array\ndesignated by this Array object, with the rows in ascending order based on the indices.\n\n*** ** * ** ***\n\n### `get``Result``Set(index, count)`\n\nFor documentation of this method, see [`java.sql.Array#getResultSet(long, int)`](https://docs.oracle.com/javase/6/docs/api/java/sql/Array.html#getResultSet(long,%20int)).\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|-----------|----------------------------------------------------------------------------------------------|\n| `index` | `Integer` | The array index of the first element to retrieve, where the first element has an index of 1. |\n| `count` | `Integer` | The number of successive SQL array elements to retrieve. |\n\n#### Return\n\n\n[JdbcResultSet](/apps-script/reference/jdbc/jdbc-result-set) --- A [JdbcResultSet](/apps-script/reference/jdbc/jdbc-result-set) containing up to the specified number of consecutive SQL array\nelements."]]
