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

Field Summary

Modifier and Type	Field and Description
private AutoSave	autoSave
private final CachedQueryCreateAction	cachedQueryCreateAction
private int	cancelKey
private int	cancelPid
private final int	cancelSignalTimeout
protected final QueryExecutorCloseAction	closeAction
private final boolean	columnSanitiserDisabled
private final String	database
private final EscapeSyntaxCallMode	escapeSyntaxCallMode
private boolean	flushCacheOnDeallocate
protected final ResourceLock	lock
protected final Condition	lockCondition
private static final Logger	LOGGER
protected final boolean	logServerErrorDetail
private final ArrayList<PGNotification>	notifications
private final TreeMap<String, String>	parameterStatuses
protected final PGStream	pgStream
private PreferQueryMode	preferQueryMode
private final boolean	quoteReturningIdentifiers
private final boolean	reWriteBatchedInserts
private @MonotonicNonNull String	serverVersion
private int	serverVersionNum
private boolean	standardConformingStrings
private final LruCache<Object, CachedQuery>	statementCache
private TransactionState	transactionState
private final String	user
private @Nullable SQLWarning	warnings

Constructor Summary

Access	Constructor and Description
protected	QueryExecutorBase(PGStream pgStream, int cancelSignalTimeout, Properties info)

Method Summary

Modifier and Type	Method and Description
public void	abort() Implements org.postgresql.core.QueryExecutor.abort. Abort at network level without sending the Terminate message to the backend.
public void	addNotification(PGNotification notification)
public void	addWarning(SQLWarning newWarning)
public final CachedQuery	borrowCallableQuery(String sql) Implements org.postgresql.core.QueryExecutor.borrowCallableQuery.
public final CachedQuery	borrowQuery(String sql) Implements org.postgresql.core.QueryExecutor.borrowQuery.
public CachedQuery	borrowQueryByKey(Object key) Implements org.postgresql.core.QueryExecutor.borrowQueryByKey.
public final CachedQuery	borrowReturningQuery(String sql, @Nullable String[] columnNames)
public void	close() Implements org.postgresql.core.QueryExecutor.close. Close this connection cleanly.
protected QueryExecutorCloseAction	createCloseAction()
public final CachedQuery	createQuery(String sql, boolean escapeProcessing, boolean isParameterized, @Nullable String... columnNames)
public CachedQuery	createQueryByKey(Object key) Implements org.postgresql.core.QueryExecutor.createQueryByKey.
public final Object	createQueryKey(String sql, boolean escapeProcessing, boolean isParameterized, @Nullable String... columnNames)
public AutoSave	getAutoSave() Implements org.postgresql.core.QueryExecutor.getAutoSave.
public int	getBackendPID() Implements org.postgresql.core.QueryExecutor.getBackendPID. Return the process ID (PID) of the backend server process handling this connection.
public Closeable	getCloseAction() Implements org.postgresql.core.QueryExecutor.getCloseAction. Returns an action that would close the connection cleanly.
public String	getDatabase() Implements org.postgresql.core.QueryExecutor.getDatabase.
public Encoding	getEncoding() Implements org.postgresql.core.QueryExecutor.getEncoding.
public EscapeSyntaxCallMode	getEscapeSyntaxCallMode() Implements org.postgresql.core.QueryExecutor.getEscapeSyntaxCallMode.
public HostSpec	getHostSpec() Implements org.postgresql.core.QueryExecutor.getHostSpec.
public int	getNetworkTimeout() Implements org.postgresql.core.QueryExecutor.getNetworkTimeout.
public PGNotification[]	getNotifications() Implements org.postgresql.core.QueryExecutor.getNotifications. Retrieve and clear the set of asynchronous notifications pending on this connection.
public final @Nullable String	getParameterStatus(String parameterName) Implements org.postgresql.core.QueryExecutor.getParameterStatus.
public final Map<String, String>	getParameterStatuses() Implements org.postgresql.core.QueryExecutor.getParameterStatuses.
public PreferQueryMode	getPreferQueryMode() Implements org.postgresql.core.QueryExecutor.getPreferQueryMode.
public boolean	getQuoteReturningIdentifiers() Implements org.postgresql.core.QueryExecutor.getQuoteReturningIdentifiers.
public String	getServerVersion() Implements org.postgresql.core.QueryExecutor.getServerVersion. Return the server version from the server_version GUC.
public int	getServerVersionNum() Implements org.postgresql.core.QueryExecutor.getServerVersionNum. Get a machine-readable server version.
public boolean	getStandardConformingStrings() Implements org.postgresql.core.QueryExecutor.getStandardConformingStrings. Returns whether the server treats string-literals according to the SQL standard or if it uses traditional PostgreSQL escaping rules.
public TransactionState	getTransactionState() Implements org.postgresql.core.QueryExecutor.getTransactionState. Get the current transaction state of this connection.
public String	getUser() Implements org.postgresql.core.QueryExecutor.getUser.
public @Nullable SQLWarning	getWarnings() Implements org.postgresql.core.QueryExecutor.getWarnings. Retrieve and clear the chain of warnings accumulated on this connection.
protected boolean	hasNotifications()
public boolean	isClosed() Implements org.postgresql.core.QueryExecutor.isClosed. Check if this connection is closed.
public boolean	isColumnSanitiserDisabled() Implements org.postgresql.core.QueryExecutor.isColumnSanitiserDisabled.
public boolean	isFlushCacheOnDeallocate()
public boolean	isReWriteBatchedInsertsEnabled() Implements org.postgresql.core.QueryExecutor.isReWriteBatchedInsertsEnabled.
protected void	onParameterStatus(String case-insensitive case-preserving name of parameter to create or update parameterName, String new value of parameter parameterStatus) Update the parameter status map in response to a new ParameterStatus wire protocol message.
public void	releaseQuery(CachedQuery cachedQuery) Implements org.postgresql.core.QueryExecutor.releaseQuery.
protected abstract void	sendCloseMessage() Deprecated use `getCloseAction()` instead Sends "terminate connection" message to the backend.
public void	sendQueryCancel() Implements org.postgresql.core.QueryExecutor.sendQueryCancel. Sends a query cancellation for this connection.
public void	setAutoSave(AutoSave autoSave) Implements org.postgresql.core.QueryExecutor.setAutoSave.
public void	setBackendKeyData(int cancelPid, int cancelKey)
public void	setEncoding(Encoding encoding)
public void	setFlushCacheOnDeallocate(boolean true if statement cache should be reset when "deallocate/discard" message observed flushCacheOnDeallocate) Implements org.postgresql.core.QueryExecutor.setFlushCacheOnDeallocate. By default, the connection resets statement cache in case deallocate all/discard all message is observed.
public void	setNetworkTimeout(int milliseconds) Implements org.postgresql.core.QueryExecutor.setNetworkTimeout.
public void	setPreferQueryMode(PreferQueryMode mode) Implements org.postgresql.core.QueryExecutor.setPreferQueryMode.
public void	setServerVersion(String serverVersion)
public void	setServerVersionNum(int serverVersionNum)
public void	setStandardConformingStrings(boolean value)
public void	setTransactionState(TransactionState state)
public boolean	willHealOnRetry(SQLException e) Implements org.postgresql.core.QueryExecutor.willHealOnRetry.
protected boolean	willHealViaReparse(SQLException e)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

autoSave	back to summary
private AutoSave autoSave

cachedQueryCreateAction	back to summary
private final CachedQueryCreateAction cachedQueryCreateAction

cancelKey	back to summary
private int cancelKey

cancelPid	back to summary
private int cancelPid

cancelSignalTimeout	back to summary
private final int cancelSignalTimeout

closeAction	back to summary
protected final QueryExecutorCloseAction closeAction

columnSanitiserDisabled	back to summary
private final boolean columnSanitiserDisabled

database	back to summary
private final String database

escapeSyntaxCallMode	back to summary
private final EscapeSyntaxCallMode escapeSyntaxCallMode

flushCacheOnDeallocate	back to summary
private boolean flushCacheOnDeallocate

lock	back to summary
protected final ResourceLock lock

lockCondition	back to summary
protected final Condition lockCondition

LOGGER	back to summary
private static final Logger LOGGER

logServerErrorDetail	back to summary
protected final boolean logServerErrorDetail

notifications	back to summary
private final ArrayList<PGNotification> notifications

parameterStatuses	back to summary
private final TreeMap<String, String> parameterStatuses

pgStream	back to summary
protected final PGStream pgStream

preferQueryMode	back to summary
private PreferQueryMode preferQueryMode

quoteReturningIdentifiers	back to summary
private final boolean quoteReturningIdentifiers

reWriteBatchedInserts	back to summary
private final boolean reWriteBatchedInserts

serverVersion	back to summary
private @MonotonicNonNull String serverVersion

serverVersionNum	back to summary
private int serverVersionNum

standardConformingStrings	back to summary
private boolean standardConformingStrings

statementCache	back to summary
private final LruCache<Object, CachedQuery> statementCache

transactionState	back to summary
private TransactionState transactionState

user	back to summary
private final String user

warnings	back to summary
private @Nullable SQLWarning warnings

Constructor Detail

QueryExecutorBase	back to summary
protected QueryExecutorBase(PGStream pgStream, int cancelSignalTimeout, Properties info) throws SQLException Annotations @SuppressWarnings:assignment, argument, method.invocation

Method Detail

abort	back to summary
public void abort() Implements org.postgresql.core.QueryExecutor.abort. Doc from org.postgresql.core.QueryExecutor.abort. Abort at network level without sending the Terminate message to the backend. Annotations @Override

abort

back to summary

public void abort()

Implements org.postgresql.core.QueryExecutor.abort.

Doc from org.postgresql.core.QueryExecutor.abort.

Abort at network level without sending the Terminate message to the backend.

Annotations

@Override

addNotification	back to summary
public void addNotification(PGNotification notification)

addWarning	back to summary
public void addWarning(SQLWarning newWarning)

borrowCallableQuery	back to summary
public final CachedQuery borrowCallableQuery(String sql) throws SQLException Implements org.postgresql.core.QueryExecutor.borrowCallableQuery. Annotations @Override

borrowCallableQuery

back to summary

public final CachedQuery borrowCallableQuery(String sql) throws SQLException

Implements org.postgresql.core.QueryExecutor.borrowCallableQuery.

Annotations

@Override

borrowQuery	back to summary
public final CachedQuery borrowQuery(String sql) throws SQLException Implements org.postgresql.core.QueryExecutor.borrowQuery. Annotations @Override

borrowQuery

back to summary

public final CachedQuery borrowQuery(String sql) throws SQLException

Implements org.postgresql.core.QueryExecutor.borrowQuery.

Annotations

@Override

borrowQueryByKey	back to summary
public CachedQuery borrowQueryByKey(Object key) throws SQLException Implements org.postgresql.core.QueryExecutor.borrowQueryByKey. Annotations @Override

borrowQueryByKey

back to summary

public CachedQuery borrowQueryByKey(Object key) throws SQLException

Implements org.postgresql.core.QueryExecutor.borrowQueryByKey.

Annotations

@Override

borrowReturningQuery	back to summary
public final CachedQuery borrowReturningQuery(String sql, @Nullable String[] columnNames) throws SQLException Annotations @Override

close	back to summary
public void close() Implements org.postgresql.core.QueryExecutor.close. Doc from org.postgresql.core.QueryExecutor.close. Close this connection cleanly. Annotations @Override

back to summary

public void close()

Implements org.postgresql.core.QueryExecutor.close.

Doc from org.postgresql.core.QueryExecutor.close.

Close this connection cleanly.

Annotations

@Override

createCloseAction	back to summary
protected QueryExecutorCloseAction createCloseAction()

createQuery	back to summary
public final CachedQuery createQuery(String sql, boolean escapeProcessing, boolean isParameterized, @Nullable String... columnNames) throws SQLException Annotations @Override

createQueryByKey	back to summary
public CachedQuery createQueryByKey(Object key) throws SQLException Implements org.postgresql.core.QueryExecutor.createQueryByKey. Annotations @Override

createQueryByKey

back to summary

public CachedQuery createQueryByKey(Object key) throws SQLException

Implements org.postgresql.core.QueryExecutor.createQueryByKey.

Annotations

@Override

createQueryKey	back to summary
public final Object createQueryKey(String sql, boolean escapeProcessing, boolean isParameterized, @Nullable String... columnNames) Annotations @Override

getAutoSave	back to summary
public AutoSave getAutoSave() Implements org.postgresql.core.QueryExecutor.getAutoSave. Annotations @Override

getAutoSave

back to summary

public AutoSave getAutoSave()

Implements org.postgresql.core.QueryExecutor.getAutoSave.

Annotations

@Override

getBackendPID	back to summary
public int getBackendPID() Implements org.postgresql.core.QueryExecutor.getBackendPID. Doc from org.postgresql.core.QueryExecutor.getBackendPID. Return the process ID (PID) of the backend server process handling this connection. Returns:int process ID (PID) of the backend server process handling this connection Annotations @Override

getBackendPID

back to summary

public int getBackendPID()

Implements org.postgresql.core.QueryExecutor.getBackendPID.

Doc from org.postgresql.core.QueryExecutor.getBackendPID.

Return the process ID (PID) of the backend server process handling this connection.

Returns:int

process ID (PID) of the backend server process handling this connection

Annotations

@Override

getCloseAction back to summary

getCloseAction	back to summary
public Closeable getCloseAction() Implements org.postgresql.core.QueryExecutor.getCloseAction. Doc from org.postgresql.core.QueryExecutor.getCloseAction. Returns an action that would close the connection cleanly. The returned object should refer only the minimum subset of objects required for proper resource cleanup. For instance, it should better not hold a strong reference to `QueryExecutor`. Returns:Closeable action that would close the connection cleanly. Annotations @Override

public Closeable getCloseAction()

Implements org.postgresql.core.QueryExecutor.getCloseAction.

Doc from org.postgresql.core.QueryExecutor.getCloseAction.

Returns an action that would close the connection cleanly. The returned object should refer only the minimum subset of objects required for proper resource cleanup. For instance, it should better not hold a strong reference to QueryExecutor.

Returns:Closeable

action that would close the connection cleanly.

Annotations

@Override

getDatabase	back to summary
public String getDatabase() Implements org.postgresql.core.QueryExecutor.getDatabase. Returns:String Doc from org.postgresql.core.QueryExecutor.getDatabase. the database this connection is connected to. Annotations @Override

getDatabase

back to summary

public String getDatabase()

Implements org.postgresql.core.QueryExecutor.getDatabase.

Returns:String

Doc from org.postgresql.core.QueryExecutor.getDatabase.

the database this connection is connected to.

Annotations

@Override

getEncoding	back to summary
public Encoding getEncoding() Implements org.postgresql.core.QueryExecutor.getEncoding. Returns:Encoding Doc from org.postgresql.core.QueryExecutor.getEncoding. the current encoding in use by this connection Annotations @Override

getEncoding

back to summary

public Encoding getEncoding()

Implements org.postgresql.core.QueryExecutor.getEncoding.

Returns:Encoding

Doc from org.postgresql.core.QueryExecutor.getEncoding.

the current encoding in use by this connection

Annotations

@Override

getEscapeSyntaxCallMode	back to summary
public EscapeSyntaxCallMode getEscapeSyntaxCallMode() Implements org.postgresql.core.QueryExecutor.getEscapeSyntaxCallMode. Annotations @Override

getEscapeSyntaxCallMode

back to summary

public EscapeSyntaxCallMode getEscapeSyntaxCallMode()

Implements org.postgresql.core.QueryExecutor.getEscapeSyntaxCallMode.

Annotations

@Override

getHostSpec	back to summary
public HostSpec getHostSpec() Implements org.postgresql.core.QueryExecutor.getHostSpec. Returns:HostSpec Doc from org.postgresql.core.QueryExecutor.getHostSpec. the host and port this connection is connected to. Annotations @Override

getHostSpec

back to summary

public HostSpec getHostSpec()

Implements org.postgresql.core.QueryExecutor.getHostSpec.

Returns:HostSpec

Doc from org.postgresql.core.QueryExecutor.getHostSpec.

the host and port this connection is connected to.

Annotations

@Override

getNetworkTimeout

back to summary

public int getNetworkTimeout() throws IOException

Implements org.postgresql.core.QueryExecutor.getNetworkTimeout.

Annotations

@Override

getNotifications

back to summary

public PGNotification[] getNotifications() throws SQLException

Implements org.postgresql.core.QueryExecutor.getNotifications.

Doc from org.postgresql.core.QueryExecutor.getNotifications.

Retrieve and clear the set of asynchronous notifications pending on this connection.

Returns:PGNotification[]

an array of notifications; if there are no notifications, an empty array is returned.

Annotations

@Override

Exceptions

SQLException:: if and error occurs while fetching notifications

getParameterStatus

back to summary

public final @Nullable String getParameterStatus(String parameterName)

Implements org.postgresql.core.QueryExecutor.getParameterStatus.

Annotations

@Override

getParameterStatuses

back to summary

public final Map<String, String> getParameterStatuses()

Implements org.postgresql.core.QueryExecutor.getParameterStatuses.

Annotations

@Override

getPreferQueryMode

back to summary

public PreferQueryMode getPreferQueryMode()

Implements org.postgresql.core.QueryExecutor.getPreferQueryMode.

Annotations

@Override

getQuoteReturningIdentifiers

back to summary

public boolean getQuoteReturningIdentifiers()

Implements org.postgresql.core.QueryExecutor.getQuoteReturningIdentifiers.

Returns:boolean

Doc from org.postgresql.core.QueryExecutor.getQuoteReturningIdentifiers.

true if we are going to quote identifier provided in the returning array default is true

Annotations

@Override

getServerVersion

back to summary

public String getServerVersion()

Implements org.postgresql.core.QueryExecutor.getServerVersion.

Doc from org.postgresql.core.QueryExecutor.getServerVersion.

Return the server version from the server_version GUC.

Note that there's no requirement for this to be numeric or of the form x.y.z. PostgreSQL development releases usually have the format x.ydevel e.g. 9.4devel; betas usually x.ybetan e.g. 9.4beta1. The --with-extra-version configure option may add an arbitrary string to this.

Don't use this string for logic, only use it when displaying the server version to the user. Prefer getServerVersionNum() for all logic purposes.

Returns:String

the server version string from the server_version GUC

Annotations

@Override

getServerVersionNum

back to summary

public int getServerVersionNum()

Implements org.postgresql.core.QueryExecutor.getServerVersionNum.

Doc from org.postgresql.core.QueryExecutor.getServerVersionNum.

Get a machine-readable server version.

This returns the value of the server_version_num GUC. If no such GUC exists, it falls back on attempting to parse the text server version for the major version. If there's no minor version (e.g. a devel or beta release) then the minor version is set to zero. If the version could not be parsed, zero is returned.

Returns:int

the server version in numeric XXYYZZ form, eg 090401, from server_version_num

Annotations

@Override

getStandardConformingStrings back to summary

public boolean getStandardConformingStrings()

Implements org.postgresql.core.QueryExecutor.getStandardConformingStrings.

Doc from org.postgresql.core.QueryExecutor.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

Annotations

@Override

getTransactionState

back to summary

public TransactionState getTransactionState()

Implements org.postgresql.core.QueryExecutor.getTransactionState.

Doc from org.postgresql.core.QueryExecutor.getTransactionState.

Get the current transaction state of this connection.

Returns:TransactionState

a ProtocolConnection.TRANSACTION_* constant.

Annotations

@Override

getUser

back to summary

public String getUser()

Implements org.postgresql.core.QueryExecutor.getUser.

Returns:String

Doc from org.postgresql.core.QueryExecutor.getUser.

the user this connection authenticated as.

Annotations

@Override

getWarnings

back to summary

public @Nullable SQLWarning getWarnings()

Implements org.postgresql.core.QueryExecutor.getWarnings.

Doc from org.postgresql.core.QueryExecutor.getWarnings.

Retrieve and clear the chain of warnings accumulated on this connection.

Returns:@Nullable SQLWarning

the first SQLWarning in the chain; subsequent warnings can be found via SQLWarning.getNextWarning().

Annotations

@Override

hasNotifications	back to summary
protected boolean hasNotifications()

isClosed

back to summary

public boolean isClosed()

Implements org.postgresql.core.QueryExecutor.isClosed.

Doc from org.postgresql.core.QueryExecutor.isClosed.

Check if this connection is closed.

Returns:boolean

true iff the connection is closed.

Annotations

@Override

isColumnSanitiserDisabled

back to summary

public boolean isColumnSanitiserDisabled()

Implements org.postgresql.core.QueryExecutor.isColumnSanitiserDisabled.

Annotations

@Override

isFlushCacheOnDeallocate	back to summary
public boolean isFlushCacheOnDeallocate()

isReWriteBatchedInsertsEnabled

back to summary

public boolean isReWriteBatchedInsertsEnabled()

Implements org.postgresql.core.QueryExecutor.isReWriteBatchedInsertsEnabled.

Annotations

@Override

onParameterStatus back to summary

protected void onParameterStatus(String parameterName, String parameterStatus)

Update the parameter status map in response to a new ParameterStatus wire protocol message.

The server sends ParameterStatus messages when GUC_REPORT settings are initially assigned and whenever they change.

A future version may invoke a client-defined listener class at this point, so this should be the only access path.

Keys are case-insensitive and case-preserving.

The server doesn't provide a way to report deletion of a reportable parameter so we don't expose one here.

Parameters

parameterName:String: case-insensitive case-preserving name of parameter to create or update
parameterStatus:String: new value of parameter

releaseQuery

back to summary

public void releaseQuery(CachedQuery cachedQuery)

Implements org.postgresql.core.QueryExecutor.releaseQuery.

Annotations

@Override

sendCloseMessage back to summary

protected abstract void sendCloseMessage() throws IOException

Deprecated

use getCloseAction() instead

Sends "terminate connection" message to the backend.

Annotations

@Deprecated

Exceptions

IOException:: in case connection termination fails

sendQueryCancel

back to summary

public void sendQueryCancel() throws SQLException

Implements org.postgresql.core.QueryExecutor.sendQueryCancel.

Doc from org.postgresql.core.QueryExecutor.sendQueryCancel.

Sends a query cancellation for this connection.

Annotations

@Override

Exceptions

SQLException:: if something goes wrong.

setAutoSave

back to summary

public void setAutoSave(AutoSave autoSave)

Implements org.postgresql.core.QueryExecutor.setAutoSave.

Annotations

@Override

setBackendKeyData	back to summary
public void setBackendKeyData(int cancelPid, int cancelKey)

setEncoding	back to summary
public void setEncoding(Encoding encoding) throws IOException

setFlushCacheOnDeallocate

back to summary

public void setFlushCacheOnDeallocate(boolean flushCacheOnDeallocate)

Implements org.postgresql.core.QueryExecutor.setFlushCacheOnDeallocate.

Doc from org.postgresql.core.QueryExecutor.setFlushCacheOnDeallocate.

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

Annotations

@Override

setNetworkTimeout

back to summary

public void setNetworkTimeout(int milliseconds) throws IOException

Implements org.postgresql.core.QueryExecutor.setNetworkTimeout.

Annotations

@Override

setPreferQueryMode	back to summary
public void setPreferQueryMode(PreferQueryMode mode) Implements org.postgresql.core.QueryExecutor.setPreferQueryMode.

setServerVersion	back to summary
public void setServerVersion(String serverVersion)

setServerVersionNum	back to summary
public void setServerVersionNum(int serverVersionNum)

setStandardConformingStrings	back to summary
public void setStandardConformingStrings(boolean value)

setTransactionState	back to summary
public void setTransactionState(TransactionState state)

willHealOnRetry

back to summary

public boolean willHealOnRetry(SQLException e)

Implements org.postgresql.core.QueryExecutor.willHealOnRetry.

Annotations

@Override

willHealViaReparse	back to summary
protected boolean willHealViaReparse(SQLException e)

public abstract Class QueryExecutorBase

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail