PostgreSQL JDBC Driver 42.7.2 · org.postgresql.core.BaseConnection

Method Summary

Modifier and Type	Method and Description
public void	addTimerTask(TimerTask timer task to schedule timerTask, long delay in milliseconds milliSeconds) Schedule a TimerTask for later execution.
public boolean	Returns: True for binary transfer, false for text transfer. binaryTransferSend(int The oid to check. oid) Returns true if value for the given oid should be sent using binary transfer.
public void	cancelQuery() Redeclares org.postgresql.PGConnection.cancelQuery. Cancel the current query executing on this connection.
public CachedQuery	createQuery(String sql, boolean escapeProcessing, boolean isParameterized, String... columnNames)
public @PolyNull byte[]	Returns: an encoded representation of the string encodeString(@PolyNull String the string to encode str) Encode a string using the database's client_encoding (usually UTF8, but can vary on older server versions).
public String	Returns: the escaped representation of the string escapeString(String a string value str) Escapes a string for use as string-literal within an SQL command.
public ResultSet	Returns: the (non-null) returned resultset execSQLQuery(String the query to execute s) Execute a SQL query that returns a single resultset.
public ResultSet	execSQLQuery(String s, int resultSetType, int resultSetConcurrency)
public void	execSQLUpdate(String the query to execute s) Execute a SQL query that does not return results.
public Encoding	getEncoding()
public LruCache<FieldMetadata.Key, FieldMetadata>	Returns: metadata cache getFieldMetadataCache() Return metadata cache for given connection.
public Logger	getLogger()
public boolean	Returns: true if should be included and passed on to other exceptions getLogServerErrorDetail() Indicates if error details from server used in included in logging and exceptions.
public Object	Returns: an appropriate object; never null. getObject(String the backend typename type, @Nullable String the type-specific string representation of the value value, @Nullable byte[] the type-specific binary representation of the value byteValue) Construct and return an appropriate object for the given type and value.
public QueryExecutor	Returns: the (non-null) executor getQueryExecutor() Get the QueryExecutor implementation for this connection.
public ReplicationProtocol	Returns: not null replication protocol getReplicationProtocol() Internal protocol for work with physical and logical replication.
public boolean	Returns: true if the server treats string literals according to the SQL standard getStandardConformingStrings() Returns whether the server treats string-literals according to the SQL standard or if it uses traditional PostgreSQL escaping rules.
public boolean	getStringVarcharFlag()
public TimestampUtils	getTimestampUtils() Deprecated
public TransactionState	Returns: current transaction state of this connection getTransactionState() Get the current transaction state of this connection.
public TypeInfo	getTypeInfo()
public PGXmlFactoryFactory	Returns: The factory to use to instantiate XML processing factories getXmlFactoryFactory() Retrieve the factory to instantiate XML processing factories.
public boolean	Returns: true if the server version is at least "ver". haveMinimumServerVersion(int the server version to check, of the form xxyyzz eg 90401 ver) Check if we have at least a particular server version.
public boolean	Returns: true if the server version is at least "ver". haveMinimumServerVersion(Version the server version to check ver) Check if we have at least a particular server version.
public boolean	Returns: Indication if hints to backend (such as when transaction begins) should be read only. hintReadOnly() Indicates if statements to backend should be hinted as read only.
public boolean	Returns: true column sanitizer is disabled isColumnSanitiserDisabled() Return whether to disable column name sanitation.
public void	purgeTimerTasks() Invoke purge() on the underlying shared Timer so that internal resources will be released.
public void	setFlushCacheOnDeallocate(boolean true if statement cache should be reset when "deallocate/discard" message observed flushCacheOnDeallocate) By default, the connection resets statement cache in case deallocate all/discard all message is observed.

Inherited from java.sql.Connection:: abort beginRequest clearWarnings close commit createArrayOf createBlob createClob createNClob createSQLXML createStatement createStatement createStatement createStruct endRequest getAutoCommit getCatalog getClientInfo getClientInfo getHoldability getMetaData getNetworkTimeout getSchema getTransactionIsolation getTypeMap getWarnings isClosed isReadOnly isValid nativeSQL prepareCall prepareCall prepareCall prepareStatement prepareStatement prepareStatement prepareStatement prepareStatement prepareStatement releaseSavepoint rollback rollback setAutoCommit setCatalog setClientInfo setClientInfo setHoldability setNetworkTimeout setReadOnly setSavepoint setSavepoint setSchema setShardingKey setShardingKey setShardingKeyIfValid setShardingKeyIfValid setTransactionIsolation setTypeMap
Inherited from org.postgresql.PGConnection:: addDataType addDataType alterUserPassword createArrayOf escapeIdentifier escapeLiteral getAdaptiveFetch getAutosave getBackendPID getCopyAPI getDefaultFetchSize getFastpathAPI getLargeObjectAPI getNotifications getNotifications getParameterStatus getParameterStatuses getPreferQueryMode getPrepareThreshold getReplicationAPI setAdaptiveFetch setAutosave setDefaultFetchSize setPrepareThreshold

Method Detail

addTimerTask	back to summary
public void addTimerTask(TimerTask timerTask, long milliSeconds) Schedule a TimerTask for later execution. The task will be scheduled with the shared Timer for this connection. Parameters timerTask:TimerTask timer task to schedule milliSeconds:long delay in milliseconds

addTimerTask

back to summary

public void addTimerTask(TimerTask timerTask, long milliSeconds)

Schedule a TimerTask for later execution. The task will be scheduled with the shared Timer for this connection.

Parameters

timerTask:TimerTask: timer task to schedule
milliSeconds:long: delay in milliseconds

binaryTransferSend	back to summary
public boolean binaryTransferSend(int oid) Returns true if value for the given oid should be sent using binary transfer. False if value should be sent using text transfer. Parameters oid:int The oid to check. Returns:boolean True for binary transfer, false for text transfer.

binaryTransferSend

back to summary

public boolean binaryTransferSend(int oid)

Returns true if value for the given oid should be sent using binary transfer. False if value should be sent using text transfer.

Parameters

oid:int: The oid to check.

Returns:boolean

True for binary transfer, false for text transfer.

cancelQuery	back to summary
public void cancelQuery() throws SQLException Redeclares org.postgresql.PGConnection.cancelQuery. Cancel the current query executing on this connection. Annotations @Override Exceptions SQLException: if something goes wrong.

cancelQuery

back to summary

public void cancelQuery() throws SQLException

Redeclares org.postgresql.PGConnection.cancelQuery.

Cancel the current query executing on this connection.

Annotations

@Override

Exceptions

SQLException:: if something goes wrong.

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

encodeString	back to summary
public @PolyNull byte[] encodeString(@PolyNull String str) throws SQLException Encode a string using the database's client_encoding (usually UTF8, but can vary on older server versions). This is used when constructing synthetic resultsets (for example, in metadata methods). Parameters str:@PolyNull String the string to encode Returns:@PolyNull byte[] an encoded representation of the string Exceptions SQLException: if something goes wrong.

encodeString

back to summary

public @PolyNull byte[] encodeString(@PolyNull String str) throws SQLException

Encode a string using the database's client_encoding (usually UTF8, but can vary on older server versions). This is used when constructing synthetic resultsets (for example, in metadata methods).

Parameters

str:@PolyNull String: the string to encode

Returns:@PolyNull byte[]

an encoded representation of the string

Exceptions

SQLException:: if something goes wrong.

escapeString back to summary

escapeString	back to summary
public String escapeString(String str) throws SQLException Escapes a string for use as string-literal within an SQL command. The method chooses the applicable escaping rules based on the value of `getStandardConformingStrings()`. Parameters str:String a string value Returns:String the escaped representation of the string Exceptions SQLException: if the string contains a `\0` character

public String escapeString(String str) throws SQLException

Escapes a string for use as string-literal within an SQL command. The method chooses the applicable escaping rules based on the value of getStandardConformingStrings().

Parameters

str:String: a string value

Returns:String

the escaped representation of the string

Exceptions

SQLException:: if the string contains a \0 character

execSQLQuery	back to summary
public ResultSet execSQLQuery(String s) throws SQLException Execute a SQL query that returns a single resultset. Never causes a new transaction to be started regardless of the autocommit setting. Parameters s:String the query to execute Returns:ResultSet the (non-null) returned resultset Exceptions SQLException: if something goes wrong.

execSQLQuery

back to summary

public ResultSet execSQLQuery(String s) throws SQLException

Execute a SQL query that returns a single resultset. Never causes a new transaction to be started regardless of the autocommit setting.

Parameters

s:String: the query to execute

Returns:ResultSet

the (non-null) returned resultset

Exceptions

SQLException:: if something goes wrong.

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

execSQLUpdate	back to summary
public void execSQLUpdate(String s) throws SQLException Execute a SQL query that does not return results. Never causes a new transaction to be started regardless of the autocommit setting. Parameters s:String the query to execute Exceptions SQLException: if something goes wrong.

execSQLUpdate

back to summary

public void execSQLUpdate(String s) throws SQLException

Execute a SQL query that does not return results. Never causes a new transaction to be started regardless of the autocommit setting.

Parameters

s:String: the query to execute

Exceptions

SQLException:: if something goes wrong.

getEncoding	back to summary
public Encoding getEncoding() throws SQLException Annotations @Pure

getFieldMetadataCache

back to summary

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

Return metadata cache for given connection.

Returns:LruCache<FieldMetadata.Key, FieldMetadata>: metadata cache

getLogger	back to summary
public Logger getLogger()

getLogServerErrorDetail	back to summary
public boolean getLogServerErrorDetail() Indicates if error details from server used in included in logging and exceptions. Returns:boolean true if should be included and passed on to other exceptions

getLogServerErrorDetail

back to summary

public boolean getLogServerErrorDetail()

Indicates if error details from server used in included in logging and exceptions.

Returns:boolean: true if should be included and passed on to other exceptions

getObject back to summary

getObject	back to summary
public Object getObject(String type, @Nullable String value, @Nullable byte[] byteValue) throws SQLException Construct and return an appropriate object for the given type and value. This only considers the types registered via `org.postgresql.PGConnection#addDataType(String, Class)` and `org.postgresql.PGConnection#addDataType(String, String)`. If no class is registered as handling the given type, then a generic `org.postgresql.util.PGobject` instance is returned. value or byteValue must be non-null Parameters type:String the backend typename value:@Nullable String the type-specific string representation of the value byteValue:@Nullable byte[] the type-specific binary representation of the value Returns:Object an appropriate object; never null. Exceptions SQLException: if something goes wrong

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

Construct and return an appropriate object for the given type and value. This only considers the types registered via org.postgresql.PGConnection#addDataType(String, Class) and org.postgresql.PGConnection#addDataType(String, String).

If no class is registered as handling the given type, then a generic org.postgresql.util.PGobject instance is returned.

value or byteValue must be non-null

Parameters

type:String: the backend typename
value:@Nullable String: the type-specific string representation of the value
byteValue:@Nullable byte[]: the type-specific binary representation of the value

Returns:Object

an appropriate object; never null.

Exceptions

SQLException:: if something goes wrong

getQueryExecutor	back to summary
public QueryExecutor getQueryExecutor() Get the QueryExecutor implementation for this connection. Returns:QueryExecutor the (non-null) executor

getQueryExecutor

back to summary

public QueryExecutor getQueryExecutor()

Get the QueryExecutor implementation for this connection.

Returns:QueryExecutor: the (non-null) executor

getReplicationProtocol	back to summary
public ReplicationProtocol getReplicationProtocol() Internal protocol for work with physical and logical replication. Physical replication available only since PostgreSQL version 9.1. Logical replication available only since PostgreSQL version 9.4. Returns:ReplicationProtocol not null replication protocol

getReplicationProtocol

back to summary

public ReplicationProtocol getReplicationProtocol()

Internal protocol for work with physical and logical replication. Physical replication available only since PostgreSQL version 9.1. Logical replication available only since PostgreSQL version 9.4.

Returns:ReplicationProtocol: not null replication protocol

getStandardConformingStrings back to summary

getStandardConformingStrings	back to summary
public boolean getStandardConformingStrings() Returns whether the server treats string-literals according to the SQL standard or if it uses traditional PostgreSQL escaping rules. Versions up to 8.1 always treated backslashes as escape characters in string-literals. Since 8.2, this depends on the value of the `standard_conforming_strings` server variable. Returns:boolean true if the server treats string literals according to the SQL standard See Also `QueryExecutor#getStandardConformingStrings()`

public boolean getStandardConformingStrings()

Returns whether the server treats string-literals according to the SQL standard or if it uses traditional PostgreSQL escaping rules. Versions up to 8.1 always treated backslashes as escape characters in string-literals. Since 8.2, this depends on the value of the standard_conforming_strings server variable.

Returns:boolean: true if the server treats string literals according to the SQL standard
See Also: QueryExecutor#getStandardConformingStrings()

getStringVarcharFlag	back to summary
public boolean getStringVarcharFlag()

getTimestampUtils	back to summary
public TimestampUtils getTimestampUtils() Deprecated Annotations @Deprecated

getTransactionState	back to summary
public TransactionState getTransactionState() Get the current transaction state of this connection. Returns:TransactionState current transaction state of this connection

getTransactionState

back to summary

public TransactionState getTransactionState()

Get the current transaction state of this connection.

Returns:TransactionState: current transaction state of this connection

getTypeInfo	back to summary
public TypeInfo getTypeInfo()

getXmlFactoryFactory	back to summary
public PGXmlFactoryFactory getXmlFactoryFactory() throws SQLException Retrieve the factory to instantiate XML processing factories. Returns:PGXmlFactoryFactory The factory to use to instantiate XML processing factories Exceptions SQLException: if the class cannot be found or instantiated.

getXmlFactoryFactory

back to summary

public PGXmlFactoryFactory getXmlFactoryFactory() throws SQLException

Retrieve the factory to instantiate XML processing factories.

Returns:PGXmlFactoryFactory

The factory to use to instantiate XML processing factories

Exceptions

SQLException:: if the class cannot be found or instantiated.

haveMinimumServerVersion	back to summary
public boolean haveMinimumServerVersion(int ver) Check if we have at least a particular server version. The input version is of the form xxyyzz, matching a PostgreSQL version like xx.yy.zz. So 9.0.12 is 90012. Parameters ver:int the server version to check, of the form xxyyzz eg 90401 Returns:boolean true if the server version is at least "ver".

haveMinimumServerVersion

back to summary

public boolean haveMinimumServerVersion(int ver)

Check if we have at least a particular server version.

The input version is of the form xxyyzz, matching a PostgreSQL version like xx.yy.zz. So 9.0.12 is 90012.

Parameters

ver:int: the server version to check, of the form xxyyzz eg 90401

Returns:boolean

true if the server version is at least "ver".

haveMinimumServerVersion	back to summary
public boolean haveMinimumServerVersion(Version ver) Check if we have at least a particular server version. The input version is of the form xxyyzz, matching a PostgreSQL version like xx.yy.zz. So 9.0.12 is 90012. Parameters ver:Version the server version to check Returns:boolean true if the server version is at least "ver".

haveMinimumServerVersion

back to summary

public boolean haveMinimumServerVersion(Version ver)

Check if we have at least a particular server version.

The input version is of the form xxyyzz, matching a PostgreSQL version like xx.yy.zz. So 9.0.12 is 90012.

Parameters

ver:Version: the server version to check

Returns:boolean

true if the server version is at least "ver".

hintReadOnly back to summary

hintReadOnly	back to summary
public boolean hintReadOnly() Indicates if statements to backend should be hinted as read only. Returns:boolean Indication if hints to backend (such as when transaction begins) should be read only. See Also `PGProperty#READ_ONLY_MODE`

public boolean hintReadOnly()

Indicates if statements to backend should be hinted as read only.

Returns:boolean: Indication if hints to backend (such as when transaction begins) should be read only.
See Also: PGProperty#READ_ONLY_MODE

isColumnSanitiserDisabled	back to summary
public boolean isColumnSanitiserDisabled() Return whether to disable column name sanitation. Returns:boolean true column sanitizer is disabled

isColumnSanitiserDisabled

back to summary

public boolean isColumnSanitiserDisabled()

Return whether to disable column name sanitation.

Returns:boolean: true column sanitizer is disabled

purgeTimerTasks	back to summary
public void purgeTimerTasks() Invoke purge() on the underlying shared Timer so that internal resources will be released.

setFlushCacheOnDeallocate	back to summary
public void setFlushCacheOnDeallocate(boolean flushCacheOnDeallocate) By default, the connection resets statement cache in case deallocate all/discard all message is observed. This API allows to disable that feature for testing purposes. Parameters flushCacheOnDeallocate:boolean true if statement cache should be reset when "deallocate/discard" message observed

setFlushCacheOnDeallocate

back to summary

public void setFlushCacheOnDeallocate(boolean flushCacheOnDeallocate)

By default, the connection resets statement cache in case deallocate all/discard all message is observed. This API allows to disable that feature for testing purposes.

Parameters

flushCacheOnDeallocate:boolean: true if statement cache should be reset when "deallocate/discard" message observed

public Interface BaseConnection

Field Summary

Method Summary

Method Detail