VastbaseG100

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

Menu

Query接口

抽象通用查询,隐藏有效执行查询所需的任何协议版本特定数据的详细信息。

当不再需要查询对象时,应该显式地关闭;如果在服务器上为该查询分配了资源,则通过关闭query触发清理。

close

功能描述

关闭此查询并释放与之关联的所有服务器端资源。资源可能不会立即释放,但关闭查询可能会使释放更加及时。

语法格式

void close()

参数说明

无。

返回值

无。

createParameterList

功能描述

创建一个适合存储与该Query关联的参数的参数列表。如果这个查询没有参数,将返回一个ParameterList,但它可能是一个共享的不可变对象。如果该查询确实有参数,则返回的ParameterList是一个新列表,不被其他调用者共享。

语法格式

ParameterList createParameterList()

参数说明

无。

返回值

一个适合此查询的ParameterList实例。

getBatchSize

功能描述

获取此查询被批处理的次数。

语法格式

int getBatchSize()

参数说明

无。

返回值

调用addBatch()的次数。

getNativeSql

功能描述

返回数据库格式的本机SQL。

语法格式

String getNativeSql()

参数说明

无。

返回值

本地数据库格式的SQL。

getResultSetColumnNameIndexMap

功能描述

获取结果集可以用来查找与名称关联的索引的映射。

语法格式

Map<String,Integer> getResultSetColumnNameIndexMap()

参数说明

无。

返回值

如果查询实现不支持此方法,则为空。

getSqlCommand

功能描述

返回查询的属性(sql关键字,和一些其他解析信息)。

语法格式

SqlCommand getSqlCommand()

参数说明

无。

返回值

返回查询的属性(sql关键字,和一些其他解析信息),如果不适用,则为空。

getSubqueries

功能描述

返回组成此查询的Query对象的列表。如果这个对象已经是一个SimpleQuery,则返回null。

语法格式

Query[] getSubqueries()

参数说明

无。

返回值

单语句查询数组,如果该对象已经是单语句查询,则为空。

isEmpty

功能描述

判断是否为空。

语法格式

boolean isEmpty()

参数说明

无。

返回值

若为空,则返回true。

isStatementDescribed

功能描述

Statement是否已描述。

语法格式

boolean isStatementDescribed()

参数说明

无。

返回值

若Statement已描述,则返回true。

replaceNativeSqlForClientLogic

功能描述

客户端替换原始sql语句。

方法原型

void replaceNativeSqlForClientLogic(String sql)

参数说明

sql:修改后的sql语句

返回值

生命周期

自V2.1版本启用。

setIsFunction

功能描述

设置当前statement状态。

方法原型

void setIsFunction(boolean isFunction)

参数说明

isFunction:修改后的sql语句

返回值

生命周期

自V2.3版本启用。

getIsFunction

功能描述

获取是否为函数。

方法原型

boolean getIsFunction( )

参数说明

返回值

是否为函数。

生命周期

自V2.3版本启用。

toString

功能描述

将此查询字符串化为人类可读的表单,用特定的参数值代替参数占位符。

语法格式

String toString(ParameterList parameters)

参数说明

parameters:此查询的createParameterList()方法返回的ParameterList,或为null以保留未替换的参数占位符。

返回值

该查询的可读表示。