VastbaseG100

基于openGauss内核开发的企业级关系型数据库。

Menu

PgArray类

功能描述

数组用于收集一列查询结果数据。

将Array类型的字段读入本机类型的Java数组对象或ResultSet。访问器方法提供了捕获数组切片的能力。

除了构造函数之外,所有方法都是java.sql.Array中指定的那些方法的直接实现。

方法说明

escapeArrayElement

功能描述

转义数组元素。

语法格式

public static void escapeArrayElement(
StringBuilder b, String s)

参数说明

参数名 参数说明
b 可变的字符序列
s 数组元素

返回值

无。

free

功能描述

此方法释放Array对象并释放其持有的资源。一旦调用free方法,该对象就无效。

定义:Array接口的free方法。

语法格式

public void free()
throws SQLException

参数说明

无。

返回值

无。

getArray()

功能描述

检索由这个Array对象以Java编程语言中的数组形式指定的SQL Array值的内容。此方法使用与连接关联的类型映射来定制类型映射。

定义:Array接口的getArray方法。

语法格式

public Object getArray() 
throws SQLException

参数说明

无。

返回值

Java编程语言中的数组,包含由Array对象指定的SQL Array值的有序元素。

getArray(long index, int count)

功能描述

检索由这个Array对象指定的SQL Array值的一个切片,从指定的索引开始,并包含SQL数组的连续元素,直到计数为止。此方法使用与连接关联的类型映射来定制类型映射。

定义:Array接口的getArray方法。

语法格式

public Object getArray(long index, int count)
throws SQLException

参数说明

参数名 参数说明
index 要检索的第一个元素的数组索引,第一个元素在索引1处
count 要检索的连续SQL数组元素的数量

返回值

包含SQL数组中最多连续元素的数组,从元素索引开始。

getArray(long index, int count, Map> map)

功能描述

检索由这个Array对象指定的SQL Array值的一个切片,从指定的索引开始,并包含SQL数组的连续元素,直到计数为止。

此方法使用指定的map进行类型映射定制,除非数组的基类型与map中的用户定义类型不匹配,在这种情况下,它使用标准映射。

定义:Array接口的getArray方法。

语法格式

public Object getArray(long index, 
int count, Map<String,
Class<?>> map)  
throws SQLException

参数说明

参数名 参数说明
index 要检索的第一个元素的数组索引,第一个元素在索引1处
count 要检索的连续SQL数组元素的数量
map map对象,它包含SQL类型名和它们映射到的Java编程语言中的类

返回值

包含了由这个数组对象指定的SQL Array值的连续元素的数组,从元素索引开始。

注意事项

该方法不适用于条件(map != null && !map.isEmpty())的情况,除此以外的情况均支持。

getArray(Map> map)

功能描述

检索由这个Array对象指定的SQL Array值的内容。此方法使用指定的map进行类型映射定制,除非数组的基类型与map中的用户定义类型不匹配,在这种情况下,它使用标准映射。

定义:Array接口的getArray方法。

语法格式

public Object getArray(Map<String,Class<?>> map) 
throws SQLException

参数说明

参数名 参数说明
map map对象,它包含SQL类型名和它们映射到的Java编程语言中的类

返回值

Java编程语言中的数组,包含由该对象指定的SQL数组的有序元素。

注意事项

该方法不适用于条件(map != null && !map.isEmpty())的情况,除此以外的情况均支持。

getArrayImpl(long index, int count, Map> map)

功能描述

getArray的具体实现。

语法格式

public Object getArrayImpl(long index,
int count,
Map<String,Class<?>> map)
throws SQLException

参数说明

参数名 参数说明
index 要检索的第一个元素的数组索引,第一个元素在索引1处
count 要检索的连续SQL数组元素的数量
map map对象,它包含SQL类型名和它们映射到的Java编程语言中的类

返回值

包含了由这个数组对象指定的SQL Array值的连续元素的数组,从元素索引开始。

注意事项

该方法不适用于条件(map != null && !map.isEmpty())的情况,除此以外的情况均支持。

getArrayImpl(Map> map)

功能描述

getArray的实现。

语法格式

public Object getArrayImpl(Map<String,
Class<?>> map) 
throws SQLException

参数说明

参数名 参数说明
map map对象,它包含SQL类型名和它们映射到的Java编程语言中的类

返回值

Java编程语言中的数组,包含由该对象指定的SQL数组的有序元素。

注意事项

该方法不适用于条件(map != null && !map.isEmpty())的情况,除此以外的情况均支持。

1.1.1.9 getBaseType

功能描述

检索由这个Array对象指定的数组中元素的JDBC类型。

定义:Array接口的getBaseType方法。

语法格式

public int getBaseType() 
throws SQLException

参数说明

无。

返回值

来自Types类的常量,它是由Array对象指定的数组中元素的类型代码。

getBaseTypeName

功能描述

检索由该Array对象指定的数组中元素的SQL类型名称。如果元素是内置类型,则返回特定于数据库的元素类型名。如果元素是用户定义的类型(UDT),则该方法返回完全限定的SQL类型名。

定义:Array接口的getBaseTypeName方法。

语法格式

public String getBaseTypeName() 
throws SQLException

参数说明

无。

返回值

内置基类型的数据库特定名称字符串;或UDT基类型的完全限定SQL类型名。

getResultSet()

功能描述

检索一个结果集,该结果集包含由该Array对象指定的SQL Array值的元素。如果合适,使用连接的类型映射来映射数组的元素;否则,将使用标准映射。

定义:Array接口的getResultSet方法。

语法格式

public ResultSet getResultSet() throws SQLException

参数说明

无。

返回值

ResultSet对象,包含数组中每个元素的一行,这些行按照索引的升序排列。

getResultSet(long index, int count)

功能描述

检索一个结果集,该结果集包含子数组的元素,子数组从索引处开始,并包含连续的元素数。如果映射包含基类型的条目,则此方法使用连接的类型映射来映射数组的元素。否则,将使用标准映射。

定义:Array接口的getResultSet方法。

语法格式

public ResultSet getResultSet(long index, 
int count) 
throws SQLException

参数说明

参数名 参数说明
index 要检索的第一个元素的数组索引;第一个元素在索引1处
count 要检索的连续SQL数组元素的数量

返回值

ResultSet对象,包含由该Array对象指定的SQL数组中最多连续的元素,从index开始。

getResultSet(long index, int count, Map> map)

功能描述

检索一个结果集,该结果集包含子数组的元素,子数组从索引处开始,并包含连续的元素数。此方法使用指定的map进行类型映射定制,除非数组的基类型与map中的用户定义类型不匹配,在这种情况下,它使用标准映射。

定义:Array接口的getResultSet方法。

语法格式

public ResultSet getResultSet(long index, 
int count,
Map<String,
Class<?>> map)
throws SQLException

参数说明

参数名 参数说明
index 要检索的第一个元素的数组索引;第一个元素在索引1处
count 要检索的连续SQL数组元素的数量
map 包含SQL类型名到Java编程语言中类的映射的Map对象

返回值

ResultSet对象,包含由该array对象指定的SQL数组中最多连续的元素,从index开始。

注意事项

该方法不适用于条件(map != null && !map.isEmpty())的情况,除此以外的情况均支持。

getResultSet(Map> map)

功能描述

检索一个结果集,该结果集包含由该Array对象指定的SQL Array值的元素。此方法使用指定的map进行类型映射定制,除非数组的基类型与map中的用户定义类型不匹配,在这种情况下,它使用标准映射。

定义:Array接口的getResultSet方法。

语法格式

public ResultSet getResultSet(Map<String,Class<?>> map) 
throws SQLException

参数说明

参数名 参数说明
map 包含SQL类型名到Java编程语言中类的映射的Map对象

返回值

ResultSet对象,包含数组中每个元素的一行,这些行按照索引的升序排列。

注意事项

该方法不适用于条件(map != null && !map.isEmpty())的情况,除此以外的情况均支持。

getResultSetImpl(long index, int count, Map> map)

功能描述

getResultSet的具体实现。

语法格式

public ResultSet getResultSetImpl(long index,
int count, 
Map<String,
Class<?>> map)
throws SQLException

参数说明

参数名 参数说明
index 要检索的第一个元素的数组索引;第一个元素在索引1处
count 要检索的连续SQL数组元素的数量
map 包含SQL类型名到Java编程语言中类的映射的Map对象

返回值

ResultSet对象,包含由该Array对象指定的SQL数组中最多连续的元素,从index开始。

注意事项

该方法不适用于条件(map != null && !map.isEmpty())的情况,除此以外的情况均支持。

getResultSetImpl(Map> map)

功能描述

getResultSet的实现。

语法格式

public ResultSet getResultSetImpl(Map<String,
Class<?>> map) 
throws SQLException

参数说明

参数名 参数说明
map 包含SQL类型名到Java编程语言中类的映射的Map对象

返回值

ResultSet对象,包含数组中每个元素的一行,这些行按照索引的升序排列。

注意事项

该方法不适用于条件(map != null && !map.isEmpty())的情况,除此以外的情况均支持。

isBinary

功能描述

是否为字节数组。

语法格式

public boolean isBinary()

参数说明

无。

返回值

True如果是字节数组,否则为False。

toBytes

功能描述

返回字节数组。

语法格式

public byte[] toBytes()

参数说明

无。

返回值

字节数组。

toString

功能描述

重写:Object类的toString方法。

语法格式

public String toString()

参数说明

无。

返回值

Array对象转换的字符串。

其他

已实现的接口:Array。