VastbaseG100

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

Menu

PgConnection类

功能描述

连接的相关方法类。

方法说明

abort()

功能描述

中止查询执行器。

语法格式

protected void abort()

参数说明

无。

返回值

无。

abort(Executor executor)

功能描述

终止一个打开的连接。调用中止的结果如下:

  • 标记为关闭的连接;

  • 关闭到数据库的任何物理连接;

  • 释放连接使用的资源;

  • 确保当前访问该连接的任何线程都将进展到完成,或者抛出SQLException异常。

调用abort标志连接关闭并释放所有资源。在一个关闭的连接上调用abort是没有操作的。

定义:Connection接口的abort方法。

语法格式

public void abort(Executor executor) 
throws SQLException

参数说明

参数名 参数说明
executor 将被中止使用的Executor实现

返回值

无。

addDataType(String type, Class<? extends PGobject> klass)

功能描述

这允许客户端代码为其中一个org.postgresql的独特数据类型添加处理程序。

定义:PGConnection接口的addDataType方法。

语法格式

public void addDataType(String type,
Class<? extends PGobject> klass) 
throws SQLException

参数说明

参数名 参数说明
type 要注册的Vastbase类型
klass 实现类型的Java表示的类;这个类必须实现PGobject

返回值

无。

addDataType(String type, String name)

功能描述

这允许客户端代码为其中一个org.postgresql独特的数据类型添加处理程序。它近似等同于addDataType(type, Class.forName(name))。

定义:PGConnection接口的addDataType方法。

语法格式

public void addDataType(String type, String name)

参数说明

参数名 参数说明
type JDBC类型名称
name 类名

返回值

无。

addTimerTask

功能描述

为以后的执行计划一个TimerTask。该任务将使用此连接的共享计时器进行调度。

定义:BaseConnection接口的addTimerTask方法。

语法格式

public void addTimerTask(TimerTask timerTask, 
long milliSeconds)

参数说明

参数名 参数说明
timerTask 要调度的定时任务
milliSeconds 以毫秒为单位的延迟

返回值

无。

addWarning

功能描述

这将向警告链添加一个警告。

语法格式

public void addWarning(SQLWarning warn)

参数说明

参数名 参数说明
warn 要添加的警告

返回值

无。

binaryTransferSend

功能描述

如果给定oid的值应该使用二进制传输方式发送,则返回True。如果值应该使用文本传输发送,则为False。

定义:BaseConnection接口的binaryTransferSend方法。

语法格式

public boolean binaryTransferSend(int oid)

参数说明

参数名 参数说明
oid 要检查的oid

返回值

True表示二进制传输,False表示文本传输。

cancelQuery

功能描述

取消在此连接上执行的当前查询。

定义:BaseConnection接口的cancelQuery方法。

语法格式

public void cancelQuery() 
throws SQLException

参数说明

无。

返回值

无。

checkClosed

功能描述

检查连接是否关闭。

语法格式

protected void checkClosed()
throws SQLException

参数说明

无。

返回值

无。

clearWarnings

功能描述

清除为此Connection对象报告的所有警告。在调用此方法之后,getWarnings方法将返回null,直到报告此Connection对象的新警告为止。

定义:Connection接口的clearWarnings方法。

语法格式

public void clearWarnings() 
throws SQLException

参数说明

无。

返回值

无。

close

功能描述

注意:即使Statement在垃圾回收时自动关闭,但为了降低资源消耗,显式关闭它会更好。

定义:Connection接口的close方法,AutoCloseable接口的close方法。

语法格式

public void close() throws SQLException

参数说明

无。

返回值

无。

commit

功能描述

使上次提交/回滚之后所做的所有更改永久生效,并释放当前由此Connection对象持有的任何数据库锁。此方法应仅在禁用自动提交模式时使用。

定义:Connection接口的commit方法。

语法格式

public void commit() 
throws SQLException

参数说明

无。

返回值

无。

createArrayOf(String typeName, Object elements)

功能描述

创建Array来包装元素。

定义:PGConnection接口的createArrayOf方法。

语法格式

public Array createArrayOf(String typeName, 
Object elements) 
throws SQLException

参数说明

参数名 参数说明
typeName 要将elements映射到的SQL类型名称,不能为空
elements 要映射的对象数组。空值将返回一个空的数组

返回值

包装了elements的数组。

createArrayOf(String typeName, Object[] elements)

功能描述

用于创建Array对象的方法。

定义:Connection接口的createArrayOf方法。

语法格式

public Array createArrayOf(String typeName,
Object[] elements) 
throws SQLException

参数说明

参数名 参数说明
typeName 数组元素映射到的SQL类型名称。typeName是一个特定于数据库的名称,它可以是内置 类型、用户定义类型或该数据库支持的标准SQL类型的名称。这是Array.getBaseTypeName返回的值
elements 填充返回对象的元素

返回值

一个数组对象,其元素映射到指定的SQL类型。

createBlob

功能描述

构造一个实现Blob接口的对象。返回的对象最初不包含任何数据。Blob接口的setBinaryStream和setBytes方法可用于向Blob添加数据。

定义:Connection接口的createBlob方法。

语法格式

public Blob createBlob() 
throws SQLException

参数说明

无。

返回值

实现Blob接口的对象。

createClob

功能描述

构造一个实现Clob接口的对象。返回的对象最初不包含任何数据。Clob接口的setAsciiStream、setCharacterStream和setString方法可以用来向Clob中添加数据。

定义:Connection接口的createClob方法。

语法格式

public Clob createClob()
throws SQLException

参数说明

无。

返回值

实现Clob接口的对象。

createNClob

功能描述

构造一个实现NClob接口的对象。返回的对象最初不包含任何数据。NClob接口的setAsciiStream、setCharacterStream和setString方法可以用来向NClob中添加数据。

定义:Connection接口的createNClob方法。

语法格式

public NClob createNClob() 
throws SQLException

参数说明

无。

返回值

实现NClob接口的对象。

注意事项

该方法尚未实现。

createQuery

功能描述

定义:BaseConnection接口的createQuery方法。

语法格式

public CachedQuery createQuery(String sql, 
            boolean escapeProcessing, 
            boolean isParameterized, 
            String... columnNames) 
            throws SQLException

参数说明

参数名 参数说明
sql sql语句
escapeProcessing 转义处理
isParameterized 是否参数化
columnNames 字段名

返回值

存储关于已解析JDBC查询的信息。

createQueryObject

功能描述

未实现的方法,创建查询对象。

语法格式

public <T> T createQueryObject(Class<T> ifc) 
throws SQLException

参数说明

参数名 参数说明
ifc 类信息

返回值

查询对象。

注意事项

该方法尚未实现。

createSQLXML

功能描述

构造一个实现SQLXML接口的对象。返回的对象最初不包含任何数据。SQLXML接口的createXmlStreamWriter对象和setString方法可用于向SQLXML对象添加数据。

定义:Connection接口的createSQLXML方法。

语法格式

public SQLXML createSQLXML() 
throws SQLException

参数说明

无。

返回值

实现SQLXML接口的对象。

createStatement()

功能描述

创建一个Statement对象,用于向数据库发送SQL语句。不带参数的SQL语句通常使用Statement对象执行。如果多次执行同一SQL语句,则使用PreparedStatement对象可能更有效。

默认情况下,使用返回的Statement对象创建的结果集的类型为TYPE_FORWARD_ONLY,并发级别为CONCUR_READ_ONLY。创建的结果集的可保持性可以通过调用getHoldability()来确定。

定义:Connection接口的createStatement方法。

语法格式

public Statement createStatement() 
throws SQLException

参数说明

无。

返回值

一个新的默认的Statement对象。

createStatement(int resultSetType, int resultSetConcurrency)

功能描述

创建一个Statement对象,该对象将生成具有给定类型和并发性的ResultSet对象。这个方法与上面的createStatement方法相同,但是它允许覆盖默认的结果集类型和并发性。创建的结果集的可保持性可以通过调用getHoldability()来确定。

定义:Connection接口的createStatement方法。

语法格式

public Statement createStatement(int resultSetType,
int resultSetConcurrency)
throws SQLException

参数说明

参数名 参数说明
resultSetType 结果集类型,ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE,ResultSet.TYPE_SCROLL_SENSITIVE之一
resultSetConcurrency 并发类型,ResultSet.CONCUR_READ_ONLY,ResultSet.CONCUR_UPDATABLE之一

返回值

一个新的Statement对象,它将生成具有给定类型和并发性的ResultSet对象。

createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)

功能描述

创建一个Statement对象,该对象将生成具有给定类型、并发性和可保持性的ResultSet对象。这个方法与上面的createStatement方法相同,但是它允许覆盖默认的结果集类型、并发性和可保持性。

定义:Connection接口的createStatement方法。

语法格式

public Statement createStatement(int resultSetType,
int resultSetConcurrency,
int resultSetHoldability)
throws SQLException

参数说明

参数名 参数说明
resultSetType 结果集类型,ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE,ResultSet.TYPE_SCROLL_SENSITIVE之一
resultSetConcurrency 并发类型,ResultSet.CONCUR_READ_ONLY,ResultSet.CONCUR_UPDATABLE之一
resultSetHoldability 可保持类型,ResultSet.HOLD_CURSORS_OVER_COMMIT ,ResultSet.CLOSE_CURSORS_AT_COMMIT之一

返回值

一个新的Statement对象,它将生成具有给定类型、并发性和可保持性的ResultSet对象。

createStruct

功能描述

未实现的方法。

定义:Connection接口的createStruct方法。

语法格式

public Struct createStruct(String typeName, 
Object[] attributes)
throws SQLException

参数说明

参数名 参数说明
typeName 这个Struct对象映射到的SQL结构化类型的SQL类型名。typeName是为该数据库定义的用户定义类型的名称。它是Struct.getSQLTypeName返回的值
attributes 填充返回对象的属性

返回值

映射到给定SQL类型并使用给定属性填充的Struct对象。

注意事项

该方法尚未实现。

createTypeInfo

功能描述

创建TypeInfo对象。

语法格式

protected TypeInfo createTypeInfo(BaseConnection conn,
int unknownLength)

参数说明

参数名 参数说明
conn 连接
unknownLength 未知的长度值

返回值

TypeInfo对象。

encodeString

功能描述

使用数据库的client_encoding编码一个字符串(通常是UTF8,但在旧的服务器版本上可以有所不同)。这在构造合成结果集时使用(例如,在metadata方法中)。

定义:BaseConnection接口的encodeString方法。

语法格式

public byte[] encodeString(String str)
throws SQLException

参数说明

参数名 参数说明
str 需要编码的字符串

返回值

已编码的字符串。

escapeIdentifier

功能描述

返回在SQL语句字符串中适当地用引号括起来作为标识符的给定字符串。引号仅在必要时才添加。嵌入的引号适当地加倍。

定义:PGConnection接口的escapeIdentifier方法。

语法格式

public String escapeIdentifier(String identifier)
throws SQLException 

参数说明

参数名 参数说明
identifier 输入的标识符

返回值

转义的标识符。

escapeLiteral

功能描述

返回在SQL语句字符串中适当引用的给定字符串作为字符串字面值使用。嵌入的单引号和反斜杠被正确地加倍。

定义:PGConnection接口的escapeLiteral方法。

语法格式

public String escapeLiteral(String literal)
throws SQLException 

参数说明

参数名 参数说明
literal 输入文字

返回值

转义的文字。

escapeString

功能描述

转义字符串,以便在SQL命令中作为字符串字面量使用。该方法根据BaseConnection.getStandardConformingStrings()的值选择适用的转义规则。

定义:BaseConnection接口的escapeString方法。

语法格式

public String escapeString(String str) 
throws SQLException

参数说明

参数名 参数说明
str 字符串

返回值

转义的字符串。

execSQLQuery(String s)

功能描述

执行一个返回单个结果集的SQL查询。无论是否设置了自动提交,都不会导致启动一个新事务。

定义:BaseConnection接口的execSQLQuery方法。

语法格式

public ResultSet execSQLQuery(String s) 
throws SQLException

参数说明

参数名 参数说明
s 执行的查询语句

返回值

返回的结果集,非空。

execSQLQuery(String s, int resultSetType, int resultSetConcurrency)

功能描述

执行一个返回结果集的SQL查询,可指定结果集类型及其并发类型。

定义:BaseConnection接口的execSQLQuery方法。

语法格式

public ResultSet execSQLQuery(String s, 
        int resultSetType,
        int resultSetConcurrency)
        throws SQLException

参数说明

参数名 参数说明
s 执行的查询语句
resultSetType 结果集类型
resultSetConcurrency 并发类型

返回值

返回的结果集,非空。

execSQLUpdate

功能描述

执行一个不返回结果的SQL查询。无论是否设置了自动提交,都不会导致启动一个新事务。

定义:BaseConnection接口的execSQLUpdate方法。

语法格式

public void execSQLUpdate(String s)
throws SQLException

参数说明

参数名 参数说明
s 执行的查询语句

返回值

无。

finalize

功能描述

如果被调用,它将关闭连接。

重写:Object类的finalize方法。

语法格式

protected void finalize() 
throws Throwable

参数说明

返回值

无。

getAutoCommit

功能描述

检索此Connection对象的当前自动提交模式。

定义:Connection接口的getAutoCommit方法。

语法格式

public boolean getAutoCommit() 
throws SQLException

参数说明

返回值

这个Connection对象的自动提交模式的当前状态。

getAutosave

功能描述

关于每个查询自动保存点的连接配置。

定义:PGConnection接口的getAutosave方法。

语法格式

public AutoSave getAutosave()

参数说明

返回值

关于每个查询自动保存点的连接配置。

getCatalog

功能描述

检索此Connection对象的当前编目名称。

定义:Connection接口的getCatalog方法。

语法格式

public String getCatalog()
throws SQLException

参数说明

返回值

当前编目名,如果没有则为空。

getClientLogic

功能描述

获取clientLogic对象的引用。

方法原型

public String getClientLogic() 

参数说明

返回值

返回当前client logic对象的引用,如果未开启改2功能,则为null。

生命周期

自V2.1版本启用。

getClientInfo()

功能描述

返回包含驱动程序支持的每个客户端信息属性的名称和当前值的列表。如果客户端信息属性没有被设置并且没有默认值,则该属性的值可能为空。

定义:Connection接口的getClientInfo方法。

语法格式

public Properties getClientInfo() 
throws SQLException

参数说明

返回值

一个Properties对象,包含驱动程序支持的每个客户端信息属性的名称和当前值。

getClientInfo(String name)

功能描述

返回由name指定的客户端信息属性的值。如果未设置指定的客户端信息属性且没有默认值,则此方法可能返回null。如果驱动程序不支持指定的客户端信息属性名,此方法也将返回null。

定义:Connection接口的getClientInfo方法。

语法格式

public String getClientInfo(String name) 
throws SQLException

参数说明

参数名 参数说明
name 要检索的客户端信息属性的名称

返回值

指定的客户信息属性的值。

getCopyAPI

功能描述

这将返回当前连接的COPY API。

定义:PGConnection接口的getCopyAPI方法。

语法格式

public CopyManager getCopyAPI() 
throws SQLException

参数说明

无。

返回值

当前连接的COPY API。

getCursorName

功能描述

获取游标名称。

语法格式

public String getCursorName()
throws SQLException

参数说明

无。

返回值

当前游标名称。

getDbCompatibility

功能描述

获取数据库兼容类型。

定义:PGConnection接口的getDbCompatibility方法。

语法格式

public String getDbCompatibility()

参数说明

无。

返回值

数据库兼容类型。

getDBVersionNumber

功能描述

获取服务器版本号。

语法格式

public String getDBVersionNumber()

参数说明

无。

返回值

服务器版本号。

getDefaultFetchSize

功能描述

获取此连接创建的语句的默认FetchSize。

定义:PGConnection接口的getDefaultFetchSize方法。

语法格式

public int getDefaultFetchSize()

参数说明

无。

返回值

默认FetchSize。

getEncoding

功能描述

获取字符集。

定义:BaseConnection接口的getEncoding方法。

语法格式

public Encoding getEncoding()

参数说明

无。

返回值

字符集。

getFastpathAPI

功能描述

这将返回当前连接的Fastpath API。

定义:PGConnection接口的getFastpathAPI方法。

语法格式

public Fastpath getFastpathAPI() 
throws SQLException

参数说明

无。

返回值

当前连接的Fastpath API。

getFetchSize

功能描述

获取此连接创建的语句的FetchSize。

语法格式

public int getFetchSize()

参数说明

无。

返回值

FetchSize。

getFieldMetadataCache

功能描述

返回给定连接的元数据缓存。

定义:BaseConnection接口的getFieldMetadataCache方法。

语法格式

public LruCache<FieldMetadata.Key,FieldMetadata> 
getFieldMetadataCache()

参数说明

无。

返回值

元数据缓存。

getForceBinary

功能描述

获取forcebinary值。

语法格式

public boolean getForceBinary()

参数说明

无。

返回值

forcebinary值。

getHoldability

功能描述

获取结果集的可保持性。

语法格式

public int getHoldability() 
throws SQLException

参数说明

无。

返回值

结果集的可保持性。

getIsolationLevelName

功能描述

获取隔离级别名称。

语法格式

protected String getIsolationLevelName(int level)

参数说明

参数名 参数说明
level 隔离级别

返回值

隔离级别名称。

getLargeObjectAPI

功能描述

返回当前连接的LargeObject API。

定义:PGConnection接口的getLargeObjectAPI方法。

语法格式

public LargeObjectManager getLargeObjectAPI() 
throws SQLException

参数说明

无。

返回值

当前连接的LargeObject API。

getLogger

功能描述

返回Logger对象。

定义:BaseConnection接口的getLogger方法。

语法格式

public Logger getLogger()

参数说明

无。

返回值

Logger对象。

getMetaData

功能描述

检索DatabaseMetaData对象,该对象包含关于此Connection对象表示连接到的数据库的元数据。元数据包括关于数据库表的信息、它所支持的SQL语法、它的存储过程、这个连接的功能等等。

定义:Connection接口的getMetaData方法。

语法格式

public DatabaseMetaData getMetaData() 
throws SQLException

参数说明

无。

返回值

这个Connection对象的DatabaseMetaData对象。

getNetworkTimeout

功能描述

检索驱动程序等待数据库请求完成的毫秒数。如果超过限制,则抛出SQLException异常。

定义:Connection接口的getNetworkTimeout方法。

语法格式

public int getNetworkTimeout()
throws SQLException

参数说明

无。

返回值

以毫秒为单位的当前超时限制;0意味着没有限制。

getNotifications()

功能描述

此方法返回自上次调用此方法以来收到的任何通知。如果没有通知,则返回null。

定义:PGConnection接口的getNotifications方法。

语法格式

public PGNotification[] getNotifications()
throws SQLException

参数说明

无。

返回值

已收到的通知。

getNotifications(int timeoutMillis)

功能描述

方法返回自上次调用此方法以来收到的任何通知。如果没有通知,则返回null。可以指定一个超时,以便驱动程序等待通知。

定义:PGConnection接口的getNotifications方法。

语法格式

public PGNotification[] getNotifications(int timeoutMillis)
throws SQLException

参数说明

参数名 参数说明
timeoutMillis 当0时,永远阻塞。当> 0时,最多阻塞指定的毫秒数,或直到至少收到一个通知。如果将要收到多个通知,这些通知将分批返回

返回值

已收到的通知。

getObject

功能描述

为给定的类型和值构造并返回一个适当的对象。这只考虑通过PGConnection.addDataType(String, Class)和PGConnection.addDataType(String, String)注册的类型。

定义:BaseConnection接口的getObject方法。

语法格式

public Object getObject(String type, 
        String value,
        byte[] byteValue) 
        throws SQLException

参数说明

参数名 参数说明
type 后端的类型名
value 特定类型的字符串表示
byteValue 特定类型的二进制表示

返回值

一个合适的对象,非空。

注意事项

该方法不适用于Custom类型的maps。

getPreferQueryMode

功能描述

返回此连接的查询模式。

当在简单查询模式下运行时,某些特性是不可用的:可调用语句、部分结果集获取、bytea类型等。

支持的特性列表可能会更改。

定义:PGConnection接口的getPreferQueryMode方法。

语法格式

public PreferQueryMode getPreferQueryMode()

参数说明

无。

返回值

首选查询模式。

getPrepareThreshold

功能描述

为从此连接创建的语句获取默认的服务器端准备重用阈值。

定义:PGConnection接口的getPrepareThreshold方法。

语法格式

public int getPrepareThreshold()

参数说明

无。

返回值

当前阈值。

getProtocolVersion

功能描述

获取协议版本号。

语法格式

public int getProtocolVersion()

参数说明

无。

返回值

协议版本号。

getQueryExecutor

功能描述

获取此连接的QueryExecutor实现。

定义:BaseConnection接口的getQueryExecutor方法。

语法格式

public QueryExecutor getQueryExecutor()

参数说明

无。

返回值

非空的执行器。

getReplicationAPI

功能描述

获取此连接的Replication API。

定义:PGConnection接口的getReplicationAPI方法。

语法格式

public PGReplicationConnection getReplicationAPI()

参数说明

无。

返回值

当前连接的Replication API。

getReplicationProtocol

功能描述

获取用于物理和逻辑复制的内部协议。

定义:BaseConnection接口的getReplicationProtocol方法。

语法格式

public ReplicationProtocol getReplicationProtocol()

参数说明

无。

返回值

非空的物理和逻辑复制协议。

getSchema

功能描述

检索此连接对象的当前模式名称。

定义:Connection接口的getSchema方法。

语法格式

public String getSchema() throws SQLException

参数说明

无。

返回值

当前模式名称,如果没有,则为NULL。

1.1.1.65 getServerMajorVersion

功能描述

获取服务器主版本。

语法格式

public int getServerMajorVersion()

参数说明

无。

返回值

服务器主版本。

getServerMinorVersion

功能描述

获取服务器次要版本。

语法格式

public int getServerMinorVersion()

参数说明

无。

返回值

服务器次要版本。

getSocketAddress

功能描述

获取套接字地址。

定义:BaseConnection接口的getSocketAddress方法。

语法格式

public String getSocketAddress()

参数说明

无。

返回值

套接字地址。

getStandardConformingStrings

功能描述

返回服务器是根据SQL标准还是使用传统的Vastbase转义规则来处理字符串字面值。这取决于standard_conforming_strings服务器变量的值。

定义:BaseConnection接口的getStandardConformingStrings方法。

语法格式

public boolean getStandardConformingStrings()

参数说明

无。

返回值

如果服务器根据SQL标准处理字符串字面量,则为True。

getStringVarcharFlag

功能描述

绑定字符串到UNSPECIFIED还是varchar。这取决于standard_conforming_strings服务器变量的值。

定义:BaseConnection接口的getStringVarcharFlag方法。

语法格式

public boolean getStringVarcharFlag()

参数说明

无。

返回值

如果绑定字符串到varchar,则为True。

getTimestampUtils

功能描述

获取处理时间和日期值的方法类实例。

定义:BaseConnection接口的getTimestampUtils方法。

语法格式

public TimestampUtils getTimestampUtils()

参数说明

无。

返回值

处理时间和日期值的方法类实例。

getTransactionIsolation

功能描述

检索此Connection对象的当前事务隔离级别。

定义:Connection接口的getTimestampUtils方法。

语法格式

public int getTransactionIsolation() throws SQLException

参数说明

无。

返回值

当前事务隔离级别,它将是以下常量之一:

Connection.TRANSACTION_READ_UNCOMMITTED,Connection.TRANSACTION_READ_COMMITTED, Connection.TRANSACTION_REPEATABLE_READ,Connection.TRANSACTION_SERIALIZABLE, Connection.TRANSACTION_NONE

getTransactionState

功能描述

获取此连接的当前事务状态。

定义:BaseConnection接口的getTransactionState方法。

语法格式

public TransactionState getTransactionState()

参数说明

无。

返回值

此连接的当前事务状态。

getTypeInfo

功能描述

获取TypeInfo对象。

定义:BaseConnection接口的getTypeInfo方法。

语法格式

public TypeInfo getTypeInfo()

参数说明

无。

返回值

TypeInfo对象。

getTypeMap

功能描述

检索与此Connection对象关联的Map对象。除非应用程序添加了一个条目,否则返回的类型映射将为空。

定义: Connection接口的getTypeMap方法。

语法格式

public Map<String,Class<?>> getTypeMap() throws SQLException

参数说明

无。

返回值

与这个Connection对象相关联的java.util.Map对象。

getURL

功能描述

返回URL。

语法格式

public String getURL() throws SQLException

参数说明

无。

返回值

URL。

getUserName

功能描述

返回用户名。

语法格式

public String getUserName() 
throws SQLException

参数说明

无。

返回值

用户名。

getWarnings

功能描述

检索此Connection对象上的调用报告的第一个警告。如果有多个警告,则后续的警告将链接到第一个警告,并可以通过调用方法SQLWarning.getNextWarning来检索。

定义:Connection接口的getWarnings方法。

语法格式

public SQLWarning getWarnings() 
throws SQLException

参数说明

无。

返回值

第一个SQLWarning对象;

如果没有SQLWarning对象,则为空。

getXmlFactoryFactory

功能描述

检索工厂以实例化XmlFactory。

定义:BaseConnection接口的getXmlFactoryFactory方法。

语法格式

public PGXmlFactoryFactory getXmlFactoryFactory()
throws SQLException

参数说明

无。

返回值

用于实例化XmlFactory的工厂。

haveMinimumServerVersion(int ver)

功能描述

检查我们是否至少有一个特定的服务器版本。

定义:BaseConnection接口的haveMinimumServerVersion方法。

语法格式

public boolean haveMinimumServerVersion(int ver)

参数说明

参数名 参数说明
ver 要检查的服务器版本,格式为xxyyzz,如:90401

返回值

如果服务器版本至少为“ver”,则为True。

haveMinimumServerVersion(Version ver)

功能描述

检查我们是否至少有一个特定的服务器版本。

定义:BaseConnection接口的haveMinimumServerVersion方法。

语法格式

public boolean haveMinimumServerVersion(Version ver)

参数说明

参数名 参数说明
ver 要检查的服务器版本

返回值

如果服务器版本至少为“ver”,则为True。

isBatchInsert

功能描述

是否为批量写入,由属性batchMode设置,与服务器属性support_batch_bind相关。

语法格式

public boolean isBatchInsert()

参数说明

无。

返回值

是批量写入,则返回True。

isBlobMode

功能描述

是否为Blob模式,由属性blobMode设置。

语法格式

public boolean isBlobMode()

参数说明

无。

返回值

是Blob模式,则返回True。

isClosed

功能描述

检索此连接对象是否已关闭。如果在连接上调用了close方法,或者发生了某些致命错误,则该连接将被关闭。这个方法只有在方法Connection.close被调用后被调用时才保证返回True。

定义:Connection接口的isClosed方法。

语法格式

public boolean isClosed() 
throws SQLException

参数说明

无。

返回值

如果这个Connection对象是关闭的,则为True;如果仍然打开,则为False。

isColumnSanitiserDisabled

功能描述

返回是否禁用列名清理。

定义:BaseConnection接口的isColumnSanitiserDisabled方法。

语法格式

public boolean isColumnSanitiserDisabled()

参数说明

无。

返回值

列名清理被禁用,则为True。

isReadOnly

功能描述

检索此Connection对象是否处于只读模式。

定义:Connection接口的isReadOnly方法。

语法格式

public boolean isReadOnly()
throws SQLException

参数说明

无。

返回值

如果这个Connection对象是只读的,则为True。

isValid

功能描述

如果连接尚未关闭且仍然有效,则返回True。驱动程序应该提交一个关于连接的查询,或者使用其他一些机制,在调用这个方法时,积极地验证连接仍然有效。

定义:Connection接口的isValid方法。

语法格式

public boolean isValid(int timeout) 
throws SQLException

参数说明

参数名 参数说明
timeout 用于验证连接的数据库操作完成所需的等待时间(以秒为单位)。如果超时时间在操作完成之前过期,此方法将返回False。值为0表示超时未应用于数据库操作

返回值

如果连接有效,则为True,否则为False。

注意事项

该方法不支持。

isWrapperFor

功能描述

定义:Wrapper接口的isWrapperFor方法。

语法格式

public boolean isWrapperFor(Class<?> iface) 
throws SQLException

参数说明

参数名 参数说明
iface 定义接口的类

返回值

如果它实现了接口或直接或间接包装了相关的对象,则为True。

注意事项

该方法在2.1版本实现。

makeArray

功能描述

构建Array对象。

语法格式

protected Array makeArray(int oid, String fieldString) 
throws SQLException

参数说明

参数名 参数说明
oid Array类型的oid
fieldString 数组的字符串数据

返回值

Array对象。

makeBlob

功能描述

构建Blob对象。

语法格式

protected Blob makeBlob(long oid) 
throws SQLException

参数说明

参数名 参数说明
oid blob类型的oid

返回值

Blob对象。

makeClob

功能描述

构建Clob对象。

语法格式

protected Clob makeClob(long oid) 
throws SQLException

参数说明

参数名 参数说明
oid clob类型的oid

返回值

Clob对象。

makeSQLXML

功能描述

构建SQLXML对象。

语法格式

protected SQLXML makeSQLXML() 
throws SQLException

参数说明

无。

返回值

SQLXML对象。

nativeSQL

功能描述

将给定的SQL语句转换为系统的原生SQL语法。驱动程序可以在发送JDBC SQL语法之前将其转换为系统的原生SQL语法。此方法返回驱动程序将发送的语句的原生形式。

定义:Connection接口的nativeSQL方法。

语法格式

public String nativeSQL(String sql)
throws SQLException

参数说明

参数名 参数说明
sql 一个SQL语句,可能包含一个或多个'?'的参数占位符

返回值

此语句的原生形式。

prepareCall(String sql)

功能描述

创建CallableStatement对象,用于调用数据库存储过程。CallableStatement对象提供了设置其IN和OUT参数的方法,以及执行对存储过程的调用的方法。

定义:Connection接口的prepareCall方法。

语法格式

public CallableStatement prepareCall(String sql) 
throws SQLException

参数说明

参数名 参数说明
sql 一个SQL语句,可能包含一个或多个'?'的参数占位符

返回值

一个新的默认CallableStatement对象,其中包含预编译的SQL语句。

prepareCall(String sql, int resultSetType, int resultSetConcurrency)

功能描述

创建一个CallableStatement对象,该对象将生成具有给定类型和并发性的ResultSet对象。这个方法与上面的prepareCall方法相同,但是它允许覆盖默认的结果集类型和并发性。创建的结果集的可保持性可以通过调用getHoldability()来确定。

定义:Connection接口的prepareCall方法。

语法格式

public CallableStatement prepareCall(String sql,
            int resultSetType,
            int resultSetConcurrency)                
            throws SQLException

参数说明

参数名 参数说明
sql 一个SQL语句,可能包含一个或多个'?'的参数占位符
resultSetType 结果集类型,ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE,ResultSet.TYPE_SCROLL_SENSITIVE之一
resultSetConcurrency 并发类型,ResultSet.CONCUR_READ_ONLY,ResultSet.CONCUR_UPDATABLE之一

返回值

一个新的CallableStatement对象,包含预编译的SQL语句,该语句将产生具有给定类型和并发性的ResultSet对象。

prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)

功能描述

创建一个CallableStatement对象,该对象将生成具有给定类型,并发性及可保持性的ResultSet对象。这个方法与上面的prepareCall方法相同,但是它允许覆盖默认的结果集类型、结果集并发类型和保持性。

定义:Connection接口的prepareCall方法。

语法格式

public CallableStatement prepareCall(String sql, 
                int resultSetType, 
                int resultSetConcurrency,               
                int resultSetHoldability)
                throws SQLException

参数说明

参数名 参数说明
sql 一个SQL语句,可能包含一个或多个'?'的参数占位符
resultSetType 结果集类型,ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE,ResultSet.TYPE_SCROLL_SENSITIVE之一
resultSetConcurrency 并发类型,ResultSet.CONCUR_READ_ONLY,ResultSet.CONCUR_UPDATABLE之一
resultSetHoldability 可保持类型,ResultSet.HOLD_CURSORS_OVER_COMMIT,ResultSet.CLOSE_CURSORS_AT_COMMIT之一

返回值

一个新的CallableStatement对象,包含预编译的SQL语句,它将生成具有给定类型、并发性和可保持性的ResultSet对象。

prepareStatement(String sql)

功能描述

创建一个PreparedStatement对象,用于将参数化的SQL语句发送到数据库。

带或不带IN参数的SQL语句可以预编译并存储在PreparedStatement对象中。然后可以使用该对象多次有效地执行该语句。

定义:Connection接口的prepareStatement方法。

语法格式

public PreparedStatement prepareStatement(String sql)
throws SQLException

参数说明

参数名 参数说明
sql 一个SQL语句,可能包含一个或多个'?'的参数占位符

返回值

包含预编译SQL语句的新的默认PreparedStatement对象。

prepareStatement(String sql, int autoGeneratedKeys)

功能描述

创建一个默认的PreparedStatement对象,该对象具有检索自动生成的键的能力。给定的常量告诉驱动程序是否应该让自动生成的键来检索。如果SQL语句不是INSERT语句,或者SQL语句能够返回自动生成的键,则忽略该参数。

定义:Connection接口的prepareStatement方法。

语法格式

public PreparedStatement prepareStatement(String sql,
    int autoGeneratedKeys)
    throws SQLException

参数说明

参数名 参数说明
sql 一个SQL语句,可能包含一个或多个'?'的参数占位符
autoGeneratedKeys 一个标志,指示是否应返回自动生成的键。可为:Statement.RETURN_GENERATED_KEYS,Statement.NO_GENERATED_KEYS

返回值

一个新的PreparedStatement对象,包含预编译的SQL语句,它将能够返回自动生成的键。

prepareStatement(String sql, int[] columnIndexes)

功能描述

创建一个默认的PreparedStatement对象,该对象能够返回由给定数组指定的自动生成的键。这个数组包含目标表中包含可用的自动生成键的列的索引。如果SQL语句不是INSERT语句,或者SQL语句能够返回自动生成的键,那么驱动程序将忽略该数组。

定义:Connection接口的prepareStatement方法。

语法格式

public PreparedStatement prepareStatement(String sql,
int[] columnIndexes)
throws SQLException

参数说明

参数名 参数说明
sql 一个SQL语句,可能包含一个或多个'?'的参数占位符
columnIndexes 一个列索引数组,指示应从插入的行或行返回的列

返回值

一个新的PreparedStatement对象,包含预编译的语句,它能够返回由给定列索引数组指定的自动生成的键。

注意事项

该方法的使用有限制条件(columnIndexes != null && columnIndexes.length == 0),除此以外的情况均不支持。

prepareStatement(String sql, int resultSetType, int resultSetConcurrency)

功能描述

创建一个PreparedStatement对象,该对象将生成具有给定类型和并发性的ResultSet对象。这个方法与上面的prepareStatement方法相同,但是它允许覆盖默认的结果集类型和并发性。创建的结果集的可保持性可以通过调用getHoldability()来确定。

定义:Connection接口的prepareStatement方法。

语法格式

public PreparedStatement prepareStatement(String sql,
        int resultSetType,
        int resultSetConcurrency)                 
        throws SQLException

参数说明

参数名 参数说明
sql 一个SQL语句,可能包含一个或多个'?'的参数占位符
resultSetType 结果集类型,可为:ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE,ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency 并发类型,可为:ResultSet.CONCUR_READ_ONLY,ResultSet.CONCUR_UPDATABLE

返回值

一个新的PreparedStatement对象,其中包含预编译的SQL语句,该语句将生成具有给定类型和并发性的ResultSet对象。

prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)

功能描述

创建一个PreparedStatement对象,该对象将生成具有给定类型、并发性和可保持性的ResultSet对象。

这个方法与上面的prepareStatement方法相同,但是它允许覆盖默认的结果集类型、并发性和可保持性。

定义:Connection接口的prepareStatement方法。

语法格式

public PreparedStatement prepareStatement(String sql, 
        int resultSetType,int resultSetConcurrency,                      
        int resultSetHoldability)
        throws SQLException

参数说明

参数名 参数说明
sql 一个SQL语句,可能包含一个或多个'?'的参数占位符
resultSetType 结果集类型,可为:ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE,ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency 并发类型,可为:ResultSet.CONCUR_READ_ONLY,ResultSet.CONCUR_UPDATABLE
resultSetHoldability 可保持类型,可为:ResultSet.HOLD_CURSORS_OVER_COMMIT,ResultSet.CLOSE_CURSORS_AT_COMMIT

返回值

一个新的PreparedStatement对象,包含预编译的SQL语句,它将生成具有给定类型、并发性和可保持性的ResultSet对象。

prepareStatement(String sql, String[] columnNames)

功能描述

创建一个默认的PreparedStatement对象,该对象能够返回由给定数组指定的自动生成的键。这个数组包含目标表中包含应该返回的自动生成键的列的名称。如果SQL语句不是INSERT语句,或者SQL语句能够返回自动生成的键,那么驱动程序将忽略该数组。

定义:Connection接口的prepareStatement方法。

语法格式

public PreparedStatement prepareStatement(String sql,
    String[] columnNames) 
    throws SQLException

参数说明

参数名 参数说明
sql 一个SQL语句,可能包含一个或多个'?'的参数占位符
columnNames 列名数组,指示应从插入的行返回的列

返回值

一个新的PreparedStatement对象,包含预编译的语句,它能够返回由给定列名数组指定的自动生成的键。

purgeTimerTasks

功能描述

在底层共享计时器上调用purge(),以便释放内部资源。

定义:BaseConnection接口的purgeTimerTasks方法。

语法格式

public void purgeTimerTasks()

参数说明

无。

返回值

无。

releaseSavepoint

功能描述

从当前事务中删除指定的保存点和后续的保存点对象。在保存点被删除后,任何对保存点的引用都会导致抛出SQLException异常。

定义:Connection接口的releaseSavepoint方法。

语法格式

public void releaseSavepoint(Savepoint savepoint) 
throws SQLException

参数说明

参数名 参数说明
savepoint 要删除的Savepoint对象

返回值

无。

rollback()

功能描述

撤销当前事务中所做的所有更改,并释放此Connection对象当前持有的所有数据库锁。此方法应仅在禁用自动提交模式时使用。

定义:Connection接口的rollback方法。

语法格式

public void rollback() throws SQLException

参数说明

无。

返回值

无。

rollback(Savepoint savepoint)

功能描述

撤销设置给定保存点对象后所做的所有更改。这个方法应该只在自动提交被禁用时使用。

定义:Connection接口的rollback方法。

语法格式

public void rollback(Savepoint savepoint) 
throws SQLException

参数说明

参数名 参数说明
savepoint 要回滚到的Savepoint对象

返回值

无。

setAutoCommit

功能描述

将此连接的自动提交模式设置为给定状态。如果一个连接处于自动提交模式,那么它的所有SQL语句将作为单独的事务执行和提交。否则,它的SQL语句被分组到事务中,这些事务通过调用方法提交或方法回滚来结束。缺省情况下,新连接采用自动提交方式。

接口Connection接口的setAutoCommit方法。

语法格式

public void setAutoCommit(boolean autoCommit) 
throws SQLException

参数说明

参数名 参数说明
autoCommit True表示启用自动提交模式;False禁用它

返回值

无。

setAutosave

功能描述

配置连接是否应该使用自动保存点。

定义:PGConnection接口的setAutosave方法。

语法格式

public void setAutosave(AutoSave autoSave)

参数说明

参数名 参数说明
autoSave 关于每个查询自动保存点的连接配置

返回值

无。

setCatalog

功能描述

设置给定的编目名称,以便选择要在其中工作的这个Connection对象的数据库的子空间。

定义:Connection接口的setCatalog方法。

语法格式

public void setCatalog(String catalog) 
throws SQLException

参数说明

参数名 参数说明
catalog 编目名称

返回值

无。

setClientInfo(Properties properties)

功能描述

设置连接的客户端信息属性的值。Properties对象包含要设置的客户端信息属性的名称和值。属性列表中包含的客户端信息属性集替换当前连接上的客户端信息属性集。如果当前在连接上设置的属性不在属性列表中,则该属性将被清除。指定一个空属性列表将清除连接上的所有属性。

定义:Connection接口的setClientInfo方法。

语法格式

public void setClientInfo(Properties properties)
throws SQLClientInfoException

参数说明

参数名 参数说明
properties 要设置的客户端信息属性列表

返回值

无。

setClientInfo(String name, String value)

功能描述

将名称指定的客户端信息属性的值设置为value指定的值。

定义:Connection接口的setClientInfo方法。

语法格式

public void setClientInfo(String name, String value) throws SQLClientInfoException

参数说明

参数名 参数说明
name 要设置的客户端信息属性的名称
value 将客户端信息属性设置为的值。如果该值为空,则清除指定属性的当前值

返回值

无。

setCursorName

功能描述

在SQL中,可以通过指定的游标检索结果表。可以使用引用游标名称的定位更新/删除语句来更新或删除结果的当前行。我们不支持定位更新/删除,所以这是一个无操作。

语法格式

public void setCursorName(String cursor) 
throws SQLException

参数说明

参数名 参数说明
cursor 游标的名称

返回值

无。

setDbCompatibility

功能描述

设置数据库兼容类型。

定义:PGConnection接口的setDbCompatibility方法。

语法格式

public void setDbCompatibility(DbCompatibility dbCompatibility)

参数说明

参数名 参数说明
dbCompatibility 数据库兼容类型,可为:postgresql,oracle,mysql(V2.3版本启用)

返回值

无。

setDefaultFetchSize

功能描述

为从此连接创建的语句设置默认的FetchSize值。

定义:PGConnection接口的setDefaultFetchSize方法。

语法格式

public void setDefaultFetchSize(int fetchSize) 
throws SQLException

参数说明

参数名 参数说明
fetchSize 新的默认FetchSize值

返回值

无。

setDisableColumnSanitiser

功能描述

设置是否禁用列名清理。

语法格式

public void setDisableColumnSanitiser(boolean disableColumnSanitiser)

参数说明

参数名 参数说明
disableColumnSanitiser True为禁用列名清理

返回值

无。

setFetchSize

功能描述

为从此连接创建的语句设置FetchSize值。

语法格式

public void setFetchSize(int fetchSize)

参数说明

参数名 参数说明
fetchSize 新的FetchSize值

返回值

无。

setFlushCacheOnDeallocate

功能描述

默认情况下,连接重置语句缓存,以防出现deallocate all/discard all消息。这个API允许出于测试目的禁用该特性。

定义:BaseConnection接口的setFlushCacheOnDeallocate方法。

语法格式

public void setFlushCacheOnDeallocate(boolean flushCacheOnDeallocate)

参数说明

参数名 参数说明
flushCacheOnDeallocate 当观察到”deallocate/discard”消息时,如果语句缓存应该重置,则为True

返回值

无。

setForceBinary

功能描述

设置forcebinary的值。

语法格式

public void setForceBinary(boolean newValue)

参数说明

参数名 参数说明
newValue 新的forcebinary值

返回值

无。

setHoldability

功能描述

将使用此Connection对象创建的ResultSet对象的默认保持性更改为给定的保持性。ResultSet对象的默认保持性可以通过调用DatabaseMetaData.getResultSetHoldability()来确定。

定义:Connection接口的setHoldability方法。

语法格式

public void setHoldability(int holdability)
throws SQLException

参数说明

参数名 参数说明
holdability 可保持类型,可为:ResultSet.HOLD_CURSORS_OVER_COMMIT,ResultSet.CLOSE_CURSORS_AT_COMMIT

返回值

无。

setNetworkTimeout

功能描述

设置Connection或从Connection创建的对象等待数据库响应任何一个请求的最长时间。如果任何请求仍然没有得到回应,等待方法将返回一个SQLException异常,并且从该连接创建的连接或对象将被标记为关闭。对象的任何后续使用,除了close、isClosed或Connection.isValid方法,将导致SQLException。

定义:Connection接口的setNetworkTimeout方法。

语法格式

public void setNetworkTimeout(Executor executor,
int milliseconds) 
throws SQLException

参数说明

参数名 参数说明
executor 执行器实现
milliseconds 等待数据库操作完成的时间(以毫秒为单位)

返回值

无。

setPrepareThreshold

功能描述

在启用服务器端准备之前设置默认语句重用阈值。

定义:PGConnection接口的setPrepareThreshold方法。

语法格式

public void setPrepareThreshold(int newThreshold)

参数说明

参数名 参数说明
newThreshold 新阈值

返回值

无。

setReadOnly

功能描述

将此连接置于只读模式,提示驱动程序启用数据库优化。

定义:Connection接口的setReadOnly方法。

语法格式

public void setReadOnly(boolean readOnly)
throws SQLException

参数说明

参数名 参数说明
readOnly True启用只读模式;False禁用它

返回值

无。

setSavepoint()

功能描述

在当前事务中创建一个未命名保存点,并返回表示该保存点的新SavePoint对象。

如果在活动事务外部调用setSavepoint,事务将在这个新创建的保存点启动。

定义:Connection接口的setSavepoint方法。

语法格式

public Savepoint setSavepoint()
throws SQLException

参数说明

无。

返回值

新的Savepoint对象。

setSavepoint(String name)

功能描述

在当前事务中创建具有给定名称的保存点,并返回表示该保存点的新SavePoint对象。

如果在活动事务外部调用setSavepoint,事务将在这个新创建的保存点启动。

定义:Connection接口的setSavepoint方法。

语法格式

public Savepoint setSavepoint(String name)
throws SQLException

参数说明

参数名 参数说明
name 保存点名称的字符串

返回值

新的Savepoint对象。

setSchema

功能描述

设置要访问的给定模式名。

定义:Connection接口的setSchema方法。

语法格式

public void setSchema(String schema) 
throws SQLException

参数说明

参数名 参数说明
schema 给定模式名

返回值

无。

setTransactionIsolation

功能描述

尝试将此Connection对象的事务隔离级别更改为给定的事务隔离级别。

定义:Connection接口的setTransactionIsolation方法。

语法格式

public void setTransactionIsolation(int level)
throws SQLException

参数说明

参数名 参数说明
level 可指定以下常量:Connection.TRANSACTION_READ_UNCOMMITTED, Connection.TRANSACTION_READ_COMMITTED,Connection.TRANSACTION_REPEATABLE_READ,Connection.TRANSACTION_SERIALIZABLE

返回值

无。

注意事项

该方法不支持事务隔离级别为0的情况。

setTypeMap

功能描述

将给定的TypeMap对象安装为这个Connection对象的类型映射。类型映射将用于SQL结构化类型和不同类型的自定义映射。

定义:Connection接口的setTypeMap方法。

语法格式

public void setTypeMap(Map<String,Class<?>> map)
throws SQLException

参数说明

参数名 参数说明
map 要安装的java.util.Map对象,作为这个Connection对象的默认类型映射的替换

返回值

无。

setTypeMapImpl

功能描述

setTypeMap的具体实现。

语法格式

public void setTypeMapImpl(Map<String,Class<?>> map)
throws SQLException

参数说明

参数名 参数说明
map 要安装的java.util.Map对象,作为这个Connection对象的默认类型映射的替换

返回值

无。

unwrap

功能描述

定义:Wrapper接口的unwrap方法。

语法格式

public <T> T unwrap(Class<T> iface)
throws SQLException

参数说明

参数名 参数说明
iface 定义结果必须实现的接口的类

返回值

实现接口的对象。可能是实际实现对象的代理。

注意事项

该方法的使用有限制条件(iface.isAssignableFrom(getClass())),即可以将要检查的类对象分配给此类的对象,除此以外的情况均不支持。

getBulkloadAPI()

功能描述

返回BulkloadManager对象。

方法原型

public BulkloadManager getBulkloadAPI()

参数说明

无。

返回值

返回BulkloadManager对象。

生命周期

自V2.2版本启用。

其他

已实现的接口:AutoCloseable, Connection, Wrapper, BaseConnection, PGConnection。