ParameterList接口

要替换到查询中的参数列表。

appendAll

功能描述

使用此操作可向当前列表追加更多参数。

语法格式

void appendAll(ParameterList list)    throws SQLException

参数说明

list：要附加的参数。

返回值

无。

bindRegisterOutParameter

功能描述 按顺序将Index位Out参数注册为对应OId

方法原型

int oid,
bolean isACompatibilityFunction)
        throws SQLException

参数说明

index：要附加的参数。

返回值

无。

生命周期

自V2.3版本启用。

clear

功能描述

解绑该列表中绑定的所有参数值。

语法格式

void clear()

参数说明

无。

返回值

无。

copy

功能描述

执行此ParameterList的浅拷贝，返回一个新实例（仍然适合传递给所属的Query）。如果这个参数列表是不可变的，copy()可能会返回相同的不可变对象。

语法格式

ParameterList copy()

参数说明

无。

返回值

一个新ParameterList实例。

getInParameterCount

功能描述

获取该列表中IN参数的数量。

语法格式

int getInParameterCount()

参数说明

无。

返回值

该列表中IN参数的数量。

getOutParameterCount

功能描述

获取该列表中OUT参数的数量。

语法格式

int getOutParameterCount()

参数说明

无。

返回值

该列表中OUT参数的数量。

getParameterCount

功能描述

获取此列表中的参数数目。对于特定的实例，这个值永远不会改变，可能为零。

语法格式

int getParameterCount()

参数说明

无。

返回值

此列表中的参数数目。

getTypeOIDs

功能描述

返回此列表中参数的oid。对于不支持参数类型的参数列表，可能为空。

语法格式

int[] getTypeOIDs()

参数说明

无。

返回值

参数的oid。

getValues

功能描述

返回绑定的参数值。

语法格式

Object[] getValues()

参数说明

无。

返回值

包含参数值的对象数组。

registerOutParameter

功能描述

按顺序位置index将OUT 参数注册为JDBC 类型sqlType。

语法格式

void registerOutParameter(int index,             
int sqlType)          
throws SQLException

参数说明

index：顺序位置。

sqlType：JDBC 类型sqlType。

返回值

无。

setBinaryParameter

功能描述

将给定的byte[]值绑定到一个参数。字节必须是与OID匹配的正确格式。

语法格式

void setBinaryParameter(int index,            
byte[] value,            
int oid)         
throws SQLException

参数说明

index：要绑定的基于l的参数索引。

value：发送的字节数。

oid：参数的类型OID。

返回值

无。

setBlob(int index, byte[] data, int offset, int length)

功能描述

将存储在字节数组中的二进制bytea值绑定到一个参数。参数的类型隐式设置为'bytea'。在查询执行完成之前，字节数组的内容应该保持不变。

语法格式

void setBlob(int index,       
byte[] data,        
int offset,       
int length)    
throws SQLException

参数说明

index：要绑定的基于l的参数索引。

data：包含原始数据值的数组。

offset：参数数据开始的数据内的偏移量。

length：要使用的数据中参数数据的字节数。

返回值

无。

setBlob(int index, InputStream stream, int length)

功能描述

绑定一个存储为InputStream的二进制字节值。参数的类型隐式设置为'bytea'。在查询执行完成之前，流应该保持有效。

语法格式

void setBlob(int index,       
InputStream stream,       
int length)    
throws SQLException

参数说明

index：要绑定的基于l的参数索引。

stream：包含参数数据的流。

length：要使用的数据中参数数据的字节数。

返回值

无。

setBytea(int index, byte[] data, int offset, int length)

功能描述

将存储为字节数组的二进制bytea值绑定到参数。参数的类型隐式设置为'bytea'。在查询执行完成之前，字节数据的内容应该保持不变。

语法格式

void setBytea(int index,       
byte[] data,       
int offset,       
int length)    
throws SQLException

参数说明

index：要绑定的基于l的参数索引。

data：包含原始数据值的数组。

offset：参数数据开始的数据内的偏移量。

length：要使用的数据中参数数据的字节数。

返回值

无。

setBytea(int index, InputStream stream)

功能描述

绑定一个存储为InputStream的二进制字节值。参数的类型隐式设置为'bytea'。在查询执行完成之前，流应该保持有效。

语法格式

void setBytea(int index,       
InputStream stream)    
throws SQLException

参数说明

index：要绑定的基于l的参数索引。

stream：包含参数数据的流。

返回值

无。

setBytea(int index, InputStream stream, int length)

功能描述

绑定一个存储为InputStream的二进制字节值。参数的类型隐式设置为'bytea'。在查询执行完成之前，流应该保持有效。

语法格式

void setBytea(int index,       
InputStream stream,       
int length)    
throws SQLException

参数说明

返回值

无。

saveLiteralValueForClientLogic(int index, String value)

功能描述

保存参数的字面值

方法原型

void saveLiteralValueForClientLogic(int index,
              String value)
       throws SQLException

参数说明

• index：索引。
• value：值。

返回值

无。

生命周期

自V2.1版本启用。

setClientLogicBytea(int index, byte[] data, int offset, int length, int customOid)

功能描述

将一个客户端逻辑值与自定义oid绑定。

方法原型

void saveLiteralValueForClientLogic(int index,
              bytea[] data,
              int offset,
              int length,
              int customOid)
       throws SQLException

参数说明

• index：绑定的参数索引。
• data：包含原始数据的数组。
• length：data中数据的长度。
• customOid：自定义oid。

返回值

无。

生命周期

自V2.1版本启用。

getLiteralValues()

功能描述

在二进制模式下返回参数的字面值。

方法原型

String[] lgetLiteralValues( )

参数说明

无

返回值

无。

生命周期

自V2.1版本启用。

setIntParameter

功能描述

将整数值绑定到参数。参数的类型隐式为“int4”。

语法格式

void setIntParameter(int index,           
int value)       
throws SQLException

参数说明

index：要绑定的基于l的参数索引。

value：要使用的整数值。

返回值

无。

setLiteralParameter

功能描述

将作为无引号文本的字符串值绑定到服务器的查询解析器（例如，纯整数）和参数。与参数关联的是参数的typename，该参数应与pg_types中的条目相对应。

语法格式

void setLiteralParameter(int index,             
String value,             
int oid)         
throws SQLException

参数说明

index：要绑定的基于l的参数索引。

value：要使用的未带引号的字符串。

oid：参数的类型OID，或0来推断类型。

返回值

无。

setNull

功能描述

将SQL NULL值绑定到一个参数。与该参数相关联的是参数的typename，该参数应该对应于pg_types中的一个条目。

语法格式

void setNull(int index,       
int oid)   
throws SQLException

参数说明

index：要绑定的基于l的参数索引。

oid：参数的类型OID，或0来推断类型。

返回值

无。

setStringParameter

功能描述

将一个String值绑定到一个参数，该值需要用引号括起来，以便服务器的解析器理解(例如，时间戳)。与该参数相关联的是一个typename，该参数应该对应于pg_types中的一个条目。

语法格式

void setStringParameter(int index,            
String value,            
int oid)         
throws SQLException

参数说明

index：要绑定的基于l的参数索引。

value：要使用的未带引号的字符串。

oid：参数的类型OID，或0来推断类型。

返回值

无。

setText

功能描述

绑定存储为一个有效UTF-8字节流的InputStream的文本值。流中的任何字节顺序标记(BOM)都被传递到后端。参数的tvpe隐式地设置为“text”。在查询执行完成之前，流应该保持有效。

语法格式

void setText(int index,       
InputStream stream)   
throws SQLException

参数说明

index：要绑定的基于l的参数索引。

stream：包含参数数据的流。

返回值

无。

toString

功能描述

返回此参数列表中特定参数的人类可读表示。如果参数未绑定，则返回“?”。

语法格式

String toString(int index,        
boolean standardConformingStrings)

参数说明

index： 要绑定的基于l的参数索引。

standardConformingStrings：如果不是字符串字面量中的转义字符，则为true。

返回值

参数的字符串表示形式。