Class QueryExecutorBase
- java.lang.Object
-
- org.postgresql.core.QueryExecutorBase
-
- All Implemented Interfaces:
QueryExecutor
,TypeTransferModeRegistry
- Direct Known Subclasses:
QueryExecutorImpl
public abstract class QueryExecutorBase extends java.lang.Object implements QueryExecutor
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
logServerErrorDetail
protected PGStream
pgStream
-
Fields inherited from interface org.postgresql.core.QueryExecutor
MAX_SAVE_POINTS, QUERY_BOTH_ROWS_AND_STATUS, QUERY_DESCRIBE_ONLY, QUERY_DISALLOW_BATCHING, QUERY_EXECUTE_AS_SIMPLE, QUERY_FORCE_DESCRIBE_PORTAL, QUERY_FORWARD_CURSOR, QUERY_NO_BINARY_TRANSFER, QUERY_NO_METADATA, QUERY_NO_RESULTS, QUERY_ONESHOT, QUERY_READ_ONLY_HINT, QUERY_SUPPRESS_BEGIN
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
QueryExecutorBase(PGStream pgStream, java.lang.String user, java.lang.String database, int cancelSignalTimeout, java.util.Properties info)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
abort()
Abort at network level without sending the Terminate message to the backend.void
addNotification(PGNotification notification)
void
addWarning(java.sql.SQLWarning newWarning)
CachedQuery
borrowCallableQuery(java.lang.String sql)
CachedQuery
borrowQuery(java.lang.String sql)
CachedQuery
borrowQueryByKey(java.lang.Object key)
CachedQuery
borrowReturningQuery(java.lang.String sql, java.lang.String[] columnNames)
void
close()
Close this connection cleanly.CachedQuery
createQuery(java.lang.String sql, boolean escapeProcessing, boolean isParameterized, java.lang.String... columnNames)
CachedQuery
createQueryByKey(java.lang.Object key)
java.lang.Object
createQueryKey(java.lang.String sql, boolean escapeProcessing, boolean isParameterized, java.lang.String... columnNames)
AutoSave
getAutoSave()
int
getBackendPID()
Return the process ID (PID) of the backend server process handling this connection.java.lang.String
getDatabase()
Encoding
getEncoding()
EscapeSyntaxCallMode
getEscapeSyntaxCallMode()
HostSpec
getHostSpec()
int
getNetworkTimeout()
PGNotification[]
getNotifications()
Retrieve and clear the set of asynchronous notifications pending on this connection.java.lang.String
getParameterStatus(java.lang.String parameterName)
java.util.Map<java.lang.String,java.lang.String>
getParameterStatuses()
PreferQueryMode
getPreferQueryMode()
java.lang.String
getServerVersion()
Return the server version from the server_version GUC.int
getServerVersionNum()
Get a machine-readable server version.boolean
getStandardConformingStrings()
Returns whether the server treats string-literals according to the SQL standard or if it uses traditional PostgreSQL escaping rules.TransactionState
getTransactionState()
Get the current transaction state of this connection.java.lang.String
getUser()
java.sql.SQLWarning
getWarnings()
Retrieve and clear the chain of warnings accumulated on this connection.protected boolean
hasNotifications()
boolean
isClosed()
Check if this connection is closed.boolean
isColumnSanitiserDisabled()
boolean
isFlushCacheOnDeallocate()
boolean
isReWriteBatchedInsertsEnabled()
protected void
onParameterStatus(java.lang.String parameterName, java.lang.String parameterStatus)
Update the parameter status map in response to a new ParameterStatus wire protocol message.void
releaseQuery(CachedQuery cachedQuery)
protected abstract void
sendCloseMessage()
void
sendQueryCancel()
Sends a query cancellation for this connection.void
setAutoSave(AutoSave autoSave)
void
setBackendKeyData(int cancelPid, int cancelKey)
void
setEncoding(Encoding encoding)
void
setFlushCacheOnDeallocate(boolean flushCacheOnDeallocate)
By default, the connection resets statement cache in case deallocate all/discard all message is observed.void
setNetworkTimeout(int milliseconds)
void
setServerVersion(java.lang.String serverVersion)
void
setServerVersionNum(int serverVersionNum)
void
setStandardConformingStrings(boolean value)
void
setTransactionState(TransactionState state)
boolean
willHealOnRetry(java.sql.SQLException e)
protected boolean
willHealViaReparse(java.sql.SQLException e)
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.postgresql.core.QueryExecutor
createFastpathParameters, createSimpleQuery, execute, execute, fastpathCall, fetch, getApplicationName, getIntegerDateTimes, getProtocolVersion, getReplicationProtocol, getTimeZone, processNotifies, processNotifies, setBinaryReceiveOids, setBinarySendOids, startCopy, wrap
-
Methods inherited from interface org.postgresql.core.v3.TypeTransferModeRegistry
useBinaryForReceive, useBinaryForSend
-
-
-
-
Field Detail
-
pgStream
protected final PGStream pgStream
-
logServerErrorDetail
protected final boolean logServerErrorDetail
-
-
Constructor Detail
-
QueryExecutorBase
protected QueryExecutorBase(PGStream pgStream, java.lang.String user, java.lang.String database, int cancelSignalTimeout, java.util.Properties info) throws java.sql.SQLException
- Throws:
java.sql.SQLException
-
-
Method Detail
-
sendCloseMessage
protected abstract void sendCloseMessage() throws java.io.IOException
- Throws:
java.io.IOException
-
setNetworkTimeout
public void setNetworkTimeout(int milliseconds) throws java.io.IOException
- Specified by:
setNetworkTimeout
in interfaceQueryExecutor
- Throws:
java.io.IOException
-
getNetworkTimeout
public int getNetworkTimeout() throws java.io.IOException
- Specified by:
getNetworkTimeout
in interfaceQueryExecutor
- Throws:
java.io.IOException
-
getHostSpec
public HostSpec getHostSpec()
- Specified by:
getHostSpec
in interfaceQueryExecutor
- Returns:
- the host and port this connection is connected to.
-
getUser
public java.lang.String getUser()
- Specified by:
getUser
in interfaceQueryExecutor
- Returns:
- the user this connection authenticated as.
-
getDatabase
public java.lang.String getDatabase()
- Specified by:
getDatabase
in interfaceQueryExecutor
- Returns:
- the database this connection is connected to.
-
setBackendKeyData
public void setBackendKeyData(int cancelPid, int cancelKey)
-
getBackendPID
public int getBackendPID()
Description copied from interface:QueryExecutor
Return the process ID (PID) of the backend server process handling this connection.- Specified by:
getBackendPID
in interfaceQueryExecutor
- Returns:
- process ID (PID) of the backend server process handling this connection
-
abort
public void abort()
Description copied from interface:QueryExecutor
Abort at network level without sending the Terminate message to the backend.- Specified by:
abort
in interfaceQueryExecutor
-
close
public void close()
Description copied from interface:QueryExecutor
Close this connection cleanly.- Specified by:
close
in interfaceQueryExecutor
-
isClosed
public boolean isClosed()
Description copied from interface:QueryExecutor
Check if this connection is closed.- Specified by:
isClosed
in interfaceQueryExecutor
- Returns:
- true iff the connection is closed.
-
sendQueryCancel
public void sendQueryCancel() throws java.sql.SQLException
Description copied from interface:QueryExecutor
Sends a query cancellation for this connection.- Specified by:
sendQueryCancel
in interfaceQueryExecutor
- Throws:
java.sql.SQLException
- if something goes wrong.
-
addWarning
public void addWarning(java.sql.SQLWarning newWarning)
-
addNotification
public void addNotification(PGNotification notification)
-
getNotifications
public PGNotification[] getNotifications() throws java.sql.SQLException
Description copied from interface:QueryExecutor
Retrieve and clear the set of asynchronous notifications pending on this connection.- Specified by:
getNotifications
in interfaceQueryExecutor
- Returns:
- an array of notifications; if there are no notifications, an empty array is returned.
- Throws:
java.sql.SQLException
- if and error occurs while fetching notifications
-
getWarnings
public java.sql.SQLWarning getWarnings()
Description copied from interface:QueryExecutor
Retrieve and clear the chain of warnings accumulated on this connection.- Specified by:
getWarnings
in interfaceQueryExecutor
- Returns:
- the first SQLWarning in the chain; subsequent warnings can be found via SQLWarning.getNextWarning().
-
getServerVersion
public java.lang.String getServerVersion()
Description copied from interface:QueryExecutor
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.
- Specified by:
getServerVersion
in interfaceQueryExecutor
- Returns:
- the server version string from the server_version guc
-
getServerVersionNum
public int getServerVersionNum()
Description copied from interface:QueryExecutor
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.
- Specified by:
getServerVersionNum
in interfaceQueryExecutor
- Returns:
- the server version in numeric XXYYZZ form, eg 090401, from server_version_num
-
setServerVersion
public void setServerVersion(java.lang.String serverVersion)
-
setServerVersionNum
public void setServerVersionNum(int serverVersionNum)
-
setTransactionState
public void setTransactionState(TransactionState state)
-
setStandardConformingStrings
public void setStandardConformingStrings(boolean value)
-
getStandardConformingStrings
public boolean getStandardConformingStrings()
Description copied from interface:QueryExecutor
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 thestandard_conforming_strings
server variable.- Specified by:
getStandardConformingStrings
in interfaceQueryExecutor
- Returns:
- true if the server treats string literals according to the SQL standard
-
getTransactionState
public TransactionState getTransactionState()
Description copied from interface:QueryExecutor
Get the current transaction state of this connection.- Specified by:
getTransactionState
in interfaceQueryExecutor
- Returns:
- a ProtocolConnection.TRANSACTION_* constant.
-
setEncoding
public void setEncoding(Encoding encoding) throws java.io.IOException
- Throws:
java.io.IOException
-
getEncoding
public Encoding getEncoding()
- Specified by:
getEncoding
in interfaceQueryExecutor
- Returns:
- the current encoding in use by this connection
-
isReWriteBatchedInsertsEnabled
public boolean isReWriteBatchedInsertsEnabled()
- Specified by:
isReWriteBatchedInsertsEnabled
in interfaceQueryExecutor
-
borrowQuery
public final CachedQuery borrowQuery(java.lang.String sql) throws java.sql.SQLException
- Specified by:
borrowQuery
in interfaceQueryExecutor
- Throws:
java.sql.SQLException
-
borrowCallableQuery
public final CachedQuery borrowCallableQuery(java.lang.String sql) throws java.sql.SQLException
- Specified by:
borrowCallableQuery
in interfaceQueryExecutor
- Throws:
java.sql.SQLException
-
borrowReturningQuery
public final CachedQuery borrowReturningQuery(java.lang.String sql, java.lang.String[] columnNames) throws java.sql.SQLException
- Specified by:
borrowReturningQuery
in interfaceQueryExecutor
- Throws:
java.sql.SQLException
-
borrowQueryByKey
public CachedQuery borrowQueryByKey(java.lang.Object key) throws java.sql.SQLException
- Specified by:
borrowQueryByKey
in interfaceQueryExecutor
- Throws:
java.sql.SQLException
-
releaseQuery
public void releaseQuery(CachedQuery cachedQuery)
- Specified by:
releaseQuery
in interfaceQueryExecutor
-
createQueryKey
public final java.lang.Object createQueryKey(java.lang.String sql, boolean escapeProcessing, boolean isParameterized, java.lang.String... columnNames)
- Specified by:
createQueryKey
in interfaceQueryExecutor
-
createQueryByKey
public CachedQuery createQueryByKey(java.lang.Object key) throws java.sql.SQLException
- Specified by:
createQueryByKey
in interfaceQueryExecutor
- Throws:
java.sql.SQLException
-
createQuery
public final CachedQuery createQuery(java.lang.String sql, boolean escapeProcessing, boolean isParameterized, java.lang.String... columnNames) throws java.sql.SQLException
- Specified by:
createQuery
in interfaceQueryExecutor
- Throws:
java.sql.SQLException
-
isColumnSanitiserDisabled
public boolean isColumnSanitiserDisabled()
- Specified by:
isColumnSanitiserDisabled
in interfaceQueryExecutor
-
getEscapeSyntaxCallMode
public EscapeSyntaxCallMode getEscapeSyntaxCallMode()
- Specified by:
getEscapeSyntaxCallMode
in interfaceQueryExecutor
-
getPreferQueryMode
public PreferQueryMode getPreferQueryMode()
- Specified by:
getPreferQueryMode
in interfaceQueryExecutor
-
getAutoSave
public AutoSave getAutoSave()
- Specified by:
getAutoSave
in interfaceQueryExecutor
-
setAutoSave
public void setAutoSave(AutoSave autoSave)
- Specified by:
setAutoSave
in interfaceQueryExecutor
-
willHealViaReparse
protected boolean willHealViaReparse(java.sql.SQLException e)
-
willHealOnRetry
public boolean willHealOnRetry(java.sql.SQLException e)
- Specified by:
willHealOnRetry
in interfaceQueryExecutor
-
isFlushCacheOnDeallocate
public boolean isFlushCacheOnDeallocate()
-
setFlushCacheOnDeallocate
public void setFlushCacheOnDeallocate(boolean flushCacheOnDeallocate)
Description copied from interface:QueryExecutor
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.- Specified by:
setFlushCacheOnDeallocate
in interfaceQueryExecutor
- Parameters:
flushCacheOnDeallocate
- true if statement cache should be reset when "deallocate/discard" message observed
-
hasNotifications
protected boolean hasNotifications()
-
getParameterStatuses
public final java.util.Map<java.lang.String,java.lang.String> getParameterStatuses()
- Specified by:
getParameterStatuses
in interfaceQueryExecutor
-
getParameterStatus
public final java.lang.String getParameterStatus(java.lang.String parameterName)
- Specified by:
getParameterStatus
in interfaceQueryExecutor
-
onParameterStatus
protected void onParameterStatus(java.lang.String parameterName, java.lang.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
- case-insensitive case-preserving name of parameter to create or updateparameterStatus
- new value of parameter- See Also:
PGConnection.getParameterStatuses()
,PGConnection.getParameterStatus(java.lang.String)
-
-