Package org.postgresql.core.v3
Class QueryExecutorImpl
java.lang.Object
org.postgresql.core.QueryExecutorBase
org.postgresql.core.v3.QueryExecutorImpl
- All Implemented Interfaces:
QueryExecutor,TypeTransferModeRegistry
QueryExecutor implementation for the V3 protocol.
-
Field Summary
Fields inherited from class org.postgresql.core.QueryExecutorBase
closeAction, lock, lockCondition, logServerErrorDetail, pgStream, protocolVersionFields 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
ConstructorsConstructorDescriptionQueryExecutorImpl(PGStream pgStream, int cancelSignalTimeout, Properties info) -
Method Summary
Modifier and TypeMethodDescriptionvoidaddBinaryReceiveOid(int oid) Adds a single oid that should be received using binary encoding.voidaddBinarySendOid(int oid) Adds a single oid that should be sent using binary encoding.voidaddQueryToAdaptiveFetchCache(boolean adaptiveFetch, ResultCursor cursor) Add query to adaptive fetch cache inside QueryExecutor.voidFinishes a copy operation and unlocks connection discarding any exchanged data.createFastpathParameters(int count) Create a new ParameterList implementation suitable for invoking a fastpath function viaQueryExecutor.fastpathCall(int, org.postgresql.core.ParameterList, boolean).createSimpleQuery(String sql) Create an unparameterized Query object suitable for execution by this QueryExecutor.voidlongFinishes writing to copy and unlocks connection.voidexecute(Query[] queries, @Nullable ParameterList[] parameterLists, BatchResultHandler batchHandler, int maxRows, int fetchSize, int flags) Execute several Query, passing results to a provided ResultHandler.voidexecute(Query[] queries, @Nullable ParameterList[] parameterLists, BatchResultHandler batchHandler, int maxRows, int fetchSize, int flags, boolean adaptiveFetch) Execute several Query with adaptive fetch, passing results to a provided ResultHandler.voidexecute(Query query, @Nullable ParameterList parameters, ResultHandler handler, int maxRows, int fetchSize, int flags) Execute a Query, passing results to a provided ResultHandler.voidexecute(Query query, @Nullable ParameterList parameters, ResultHandler handler, int maxRows, int fetchSize, int flags, boolean adaptiveFetch) Execute a Query with adaptive fetch, passing results to a provided ResultHandler.byte @Nullable []fastpathCall(int fnid, ParameterList parameters, boolean suppressBegin) Invoke a backend function via the fastpath interface.voidfetch(ResultCursor cursor, ResultHandler handler, int fetchSize, boolean adaptiveFetch) Fetch additional rows from a cursor.voidbooleanGet state of adaptive fetch inside QueryExecutor.intgetAdaptiveFetchSize(boolean adaptiveFetch, ResultCursor cursor) Get fetch size computed by adaptive fetch size for given query.Returns application_name connection property.Gets the oids that should be received using binary encoding.Gets the oids that should be sent using binary encoding.booleanReturns true if server uses integer instead of double for binary date and time encodings.@Nullable TimeZoneReturns backend timezone in java format.voidPrior to attempting to retrieve notifications, we need to pull any recently received notifications off of the network buffers.voidprocessNotifies(int timeoutMillis) Prior to attempting to retrieve notifications, we need to pull any recently received notifications off of the network buffers.protected voidprocessResults(ResultHandler handler, int flags) protected voidprocessResults(ResultHandler handler, int flags, boolean adaptiveFetch) voidvoidvoidremoveBinaryReceiveOid(int oid) Remove given oid from the list of oids for binary receive encoding.voidremoveBinarySendOid(int oid) Remove given oid from the list of oids for binary send encoding.voidremoveQueryFromAdaptiveFetchCache(boolean adaptiveFetch, ResultCursor cursor) Remove query from adaptive fetch cache inside QueryExecutorprotected voidSends "terminate connection" message to the backend.voidsetAdaptiveFetch(boolean adaptiveFetch) Set state of adaptive fetch inside QueryExecutor.voidsetApplicationName(String applicationName) voidsetBinaryReceiveOids(Set<Integer> oids) Sets the oids that should be received using binary encoding.voidsetBinarySendOids(Set<Integer> oids) Sets the oids that should be sent using binary encoding.voidsetTimeZone(TimeZone timeZone) Sends given query to BE to start, initialize and lock connection for a CopyOperation.booleanuseBinaryForReceive(int oid) Returns if given oid should be received in binary format.booleanuseBinaryForSend(int oid) Returns if given oid should be sent in binary format.wrap(List<NativeQuery> queries) Wrap given native query into a ready for execution format.voidwriteToCopy(CopyOperationImpl op, byte[] data, int off, int siz) Sends data during a live COPY IN operation.voidwriteToCopy(CopyOperationImpl op, ByteStreamWriter from) Sends data during a live COPY IN operation.Methods inherited from class org.postgresql.core.QueryExecutorBase
abort, addNotification, addWarning, borrowCallableQuery, borrowQuery, borrowQueryByKey, borrowReturningQuery, close, createCloseAction, createQuery, createQueryByKey, createQueryKey, getAutoSave, getBackendPID, getCloseAction, getDatabase, getEncoding, getEscapeSyntaxCallMode, getHostSpec, getNetworkTimeout, getNotifications, getParameterStatus, getParameterStatuses, getPreferQueryMode, getQuoteReturningIdentifiers, getServerVersion, getServerVersionNum, getStandardConformingStrings, getTransactionState, getUser, getWarnings, hasNotifications, isClosed, isColumnSanitiserDisabled, isFlushCacheOnDeallocate, isReWriteBatchedInsertsEnabled, onParameterStatus, releaseQuery, sendQueryCancel, setAutoSave, setBackendKeyData, setEncoding, setFlushCacheOnDeallocate, setNetworkTimeout, setPreferQueryMode, setServerVersion, setServerVersionNum, setStandardConformingStrings, setTransactionState, willHealOnRetry, willHealViaReparse
-
Constructor Details
-
QueryExecutorImpl
public QueryExecutorImpl(PGStream pgStream, int cancelSignalTimeout, Properties info) throws SQLException, IOException - Throws:
SQLExceptionIOException
-
-
Method Details
-
getProtocolVersion
- Returns:
- the version of the implementation
-
createSimpleQuery
Description copied from interface:QueryExecutorCreate an unparameterized Query object suitable for execution by this QueryExecutor. The provided query string is not parsed for parameter placeholders ('?' characters), and theQuery.createParameterList()of the returned object will always return an empty ParameterList.- Parameters:
sql- the SQL for the query to create- Returns:
- a new Query object
- Throws:
SQLException- if something goes wrong
-
wrap
Description copied from interface:QueryExecutorWrap given native query into a ready for execution format.- Parameters:
queries- list of queries in native to database syntax- Returns:
- query object ready for execution by this query executor
-
execute
public void execute(Query query, @Nullable ParameterList parameters, ResultHandler handler, int maxRows, int fetchSize, int flags) throws SQLException Description copied from interface:QueryExecutorExecute a Query, passing results to a provided ResultHandler.- Parameters:
query- the query to execute; must be a query returned from callingQueryExecutor.wrap(List)on this QueryExecutor object.parameters- the parameters for the query. Must be non-nullif the query takes parameters. Must be a parameter object returned byQuery.createParameterList().handler- a ResultHandler responsible for handling results generated by this querymaxRows- the maximum number of rows to retrievefetchSize- if QUERY_FORWARD_CURSOR is set, the preferred number of rows to retrieve before suspendingflags- a combination of QUERY_* flags indicating how to handle the query.- Throws:
SQLException- if query execution fails
-
execute
public void execute(Query query, @Nullable ParameterList parameters, ResultHandler handler, int maxRows, int fetchSize, int flags, boolean adaptiveFetch) throws SQLException Description copied from interface:QueryExecutorExecute a Query with adaptive fetch, passing results to a provided ResultHandler.- Parameters:
query- the query to execute; must be a query returned from callingQueryExecutor.wrap(List)on this QueryExecutor object.parameters- the parameters for the query. Must be non-nullif the query takes parameters. Must be a parameter object returned byQuery.createParameterList().handler- a ResultHandler responsible for handling results generated by this querymaxRows- the maximum number of rows to retrievefetchSize- if QUERY_FORWARD_CURSOR is set, the preferred number of rows to retrieve before suspendingflags- a combination of QUERY_* flags indicating how to handle the query.adaptiveFetch- state of adaptiveFetch to use during execution- Throws:
SQLException- if query execution fails
-
execute
public void execute(Query[] queries, @Nullable ParameterList[] parameterLists, BatchResultHandler batchHandler, int maxRows, int fetchSize, int flags) throws SQLException Description copied from interface:QueryExecutorExecute several Query, passing results to a provided ResultHandler.- Parameters:
queries- the queries to execute; each must be a query returned from callingQueryExecutor.wrap(List)on this QueryExecutor object.parameterLists- the parameter lists for the queries. The parameter lists correspond 1:1 to the queries passed in thequeriesarray. Each must be non-nullif the corresponding query takes parameters, and must be a parameter object returned byQuery.createParameterList()created by the corresponding query.batchHandler- a ResultHandler responsible for handling results generated by this querymaxRows- the maximum number of rows to retrievefetchSize- if QUERY_FORWARD_CURSOR is set, the preferred number of rows to retrieve before suspendingflags- a combination of QUERY_* flags indicating how to handle the query.- Throws:
SQLException- if query execution fails
-
execute
public void execute(Query[] queries, @Nullable ParameterList[] parameterLists, BatchResultHandler batchHandler, int maxRows, int fetchSize, int flags, boolean adaptiveFetch) throws SQLException Description copied from interface:QueryExecutorExecute several Query with adaptive fetch, passing results to a provided ResultHandler.- Parameters:
queries- the queries to execute; each must be a query returned from callingQueryExecutor.wrap(List)on this QueryExecutor object.parameterLists- the parameter lists for the queries. The parameter lists correspond 1:1 to the queries passed in thequeriesarray. Each must be non-nullif the corresponding query takes parameters, and must be a parameter object returned byQuery.createParameterList()created by the corresponding query.batchHandler- a ResultHandler responsible for handling results generated by this querymaxRows- the maximum number of rows to retrievefetchSize- if QUERY_FORWARD_CURSOR is set, the preferred number of rows to retrieve before suspendingflags- a combination of QUERY_* flags indicating how to handle the query.adaptiveFetch- state of adaptiveFetch to use during execution- Throws:
SQLException- if query execution fails
-
fastpathCall
public byte @Nullable [] fastpathCall(int fnid, ParameterList parameters, boolean suppressBegin) throws SQLException Description copied from interface:QueryExecutorInvoke a backend function via the fastpath interface.- Parameters:
fnid- the OID of the backend function to invokeparameters- a ParameterList returned fromQueryExecutor.createFastpathParameters(int)containing the parameters to pass to the backend functionsuppressBegin- if begin should be suppressed- Returns:
- the binary-format result of the fastpath call, or
nullif a void result was returned - Throws:
SQLException- if an error occurs while executing the fastpath call
-
doSubprotocolBegin
- Throws:
SQLException
-
createFastpathParameters
Description copied from interface:QueryExecutorCreate a new ParameterList implementation suitable for invoking a fastpath function viaQueryExecutor.fastpathCall(int, org.postgresql.core.ParameterList, boolean).- Parameters:
count- the number of parameters the fastpath call will take- Returns:
- a ParameterList suitable for passing to
QueryExecutor.fastpathCall(int, org.postgresql.core.ParameterList, boolean).
-
processNotifies
Description copied from interface:QueryExecutorPrior to attempting to retrieve notifications, we need to pull any recently received notifications off of the network buffers. The notification retrieval in ProtocolConnection cannot do this as it is prone to deadlock, so the higher level caller must be responsible which requires exposing this method.- Throws:
SQLException- if and error occurs while fetching notifications
-
processNotifies
Description copied from interface:QueryExecutorPrior to attempting to retrieve notifications, we need to pull any recently received notifications off of the network buffers. The notification retrieval in ProtocolConnection cannot do this as it is prone to deadlock, so the higher level caller must be responsible which requires exposing this method. This variant supports blocking for the given time in millis.- Parameters:
timeoutMillis- when > 0, block for this time when =0, block forever when < 0, don't block- Throws:
SQLException- if and error occurs while fetching notifications
-
startCopy
Sends given query to BE to start, initialize and lock connection for a CopyOperation.- Parameters:
sql- COPY FROM STDIN / COPY TO STDOUT statementsuppressBegin- if begin should be suppressed- Returns:
- CopyIn or CopyOut operation object
- Throws:
SQLException- on failure
-
cancelCopy
Finishes a copy operation and unlocks connection discarding any exchanged data.- Parameters:
op- the copy operation presumably currently holding lock on this connection- Throws:
SQLException- on any additional failure
-
endCopy
Finishes writing to copy and unlocks connection.- Parameters:
op- the copy operation presumably currently holding lock on this connection- Returns:
- number of rows updated for server versions 8.2 or newer
- Throws:
SQLException- on failure
-
writeToCopy
Sends data during a live COPY IN operation. Only unlocks the connection if server suddenly returns CommandComplete, which should not happen- Parameters:
op- the CopyIn operation presumably currently holding lock on this connectiondata- bytes to sendoff- index of first byte to send (usually 0)siz- number of bytes to send (usually data.length)- Throws:
SQLException- on failure
-
writeToCopy
Sends data during a live COPY IN operation. Only unlocks the connection if server suddenly returns CommandComplete, which should not happen- Parameters:
op- the CopyIn operation presumably currently holding lock on this connectionfrom- the source of bytes, e.g. a ByteBufferByteStreamWriter- Throws:
SQLException- on failure
-
flushCopy
- Throws:
SQLException
-
processResults
- Throws:
IOException
-
processResults
protected void processResults(ResultHandler handler, int flags, boolean adaptiveFetch) throws IOException - Throws:
IOException
-
fetch
public void fetch(ResultCursor cursor, ResultHandler handler, int fetchSize, boolean adaptiveFetch) throws SQLException Description copied from interface:QueryExecutorFetch additional rows from a cursor.- Parameters:
cursor- the cursor to fetch fromhandler- the handler to feed results tofetchSize- the preferred number of rows to retrieve before suspendingadaptiveFetch- state of adaptiveFetch to use during fetching- Throws:
SQLException- if query execution fails
-
getAdaptiveFetchSize
Description copied from interface:QueryExecutorGet fetch size computed by adaptive fetch size for given query.- Parameters:
adaptiveFetch- state of adaptive fetch, which should be used during retrievingcursor- Cursor used by resultSet, containing query, have to be able to cast to Portal class.- Returns:
- fetch size computed by adaptive fetch size for given query passed inside cursor
-
setAdaptiveFetch
public void setAdaptiveFetch(boolean adaptiveFetch) Description copied from interface:QueryExecutorSet state of adaptive fetch inside QueryExecutor.- Parameters:
adaptiveFetch- desired state of adaptive fetch
-
getAdaptiveFetch
public boolean getAdaptiveFetch()Description copied from interface:QueryExecutorGet state of adaptive fetch inside QueryExecutor.- Returns:
- state of adaptive fetch inside QueryExecutor
-
addQueryToAdaptiveFetchCache
Description copied from interface:QueryExecutorAdd query to adaptive fetch cache inside QueryExecutor.- Parameters:
adaptiveFetch- state of adaptive fetch used during adding querycursor- Cursor used by resultSet, containing query, have to be able to cast to Portal class.
-
removeQueryFromAdaptiveFetchCache
Description copied from interface:QueryExecutorRemove query from adaptive fetch cache inside QueryExecutor- Parameters:
adaptiveFetch- state of adaptive fetch used during removing querycursor- Cursor used by resultSet, containing query, have to be able to cast to Portal class.
-
sendCloseMessage
Description copied from class:QueryExecutorBaseSends "terminate connection" message to the backend.- Specified by:
sendCloseMessagein classQueryExecutorBase- Throws:
IOException- in case connection termination fails
-
readStartupMessages
- Throws:
IOExceptionSQLException
-
receiveParameterStatus
- Throws:
IOExceptionSQLException
-
setTimeZone
-
getTimeZone
Description copied from interface:QueryExecutorReturns backend timezone in java format.- Returns:
- backend timezone in java format.
-
setApplicationName
-
getApplicationName
Description copied from interface:QueryExecutorReturns application_name connection property.- Returns:
- application_name connection property
-
getReplicationProtocol
- Returns:
- the ReplicationProtocol instance for this connection.
-
addBinaryReceiveOid
public void addBinaryReceiveOid(int oid) Description copied from interface:QueryExecutorAdds a single oid that should be received using binary encoding.- Parameters:
oid- The oid to request with binary encoding.
-
removeBinaryReceiveOid
public void removeBinaryReceiveOid(int oid) Description copied from interface:QueryExecutorRemove given oid from the list of oids for binary receive encoding.Note: the binary receive for the oid can be re-activated later.
- Parameters:
oid- The oid to request with binary encoding.
-
getBinaryReceiveOids
Description copied from interface:QueryExecutorGets the oids that should be received using binary encoding.Note: this returns an unmodifiable set, and its contents might not reflect the current state.
- Returns:
- The oids to request with binary encoding.
-
useBinaryForReceive
public boolean useBinaryForReceive(int oid) Description copied from interface:TypeTransferModeRegistryReturns if given oid should be received in binary format.- Parameters:
oid- type oid- Returns:
- true if given oid should be received in binary format
-
setBinaryReceiveOids
Description copied from interface:QueryExecutorSets the oids that should be received using binary encoding.- Parameters:
oids- The oids to request with binary encoding.
-
addBinarySendOid
public void addBinarySendOid(int oid) Description copied from interface:QueryExecutorAdds a single oid that should be sent using binary encoding.- Parameters:
oid- The oid to send with binary encoding.
-
removeBinarySendOid
public void removeBinarySendOid(int oid) Description copied from interface:QueryExecutorRemove given oid from the list of oids for binary send encoding.Note: the binary send for the oid can be re-activated later.
- Parameters:
oid- The oid to send with binary encoding.
-
getBinarySendOids
Description copied from interface:QueryExecutorGets the oids that should be sent using binary encoding.Note: this returns an unmodifiable set, and its contents might not reflect the current state.
- Returns:
- useBinaryForOids The oids to send with binary encoding.
-
useBinaryForSend
public boolean useBinaryForSend(int oid) Description copied from interface:TypeTransferModeRegistryReturns if given oid should be sent in binary format.- Parameters:
oid- type oid- Returns:
- true if given oid should be sent in binary format
-
setBinarySendOids
Description copied from interface:QueryExecutorSets the oids that should be sent using binary encoding.- Parameters:
oids- The oids to send with binary encoding.
-
getIntegerDateTimes
public boolean getIntegerDateTimes()Description copied from interface:QueryExecutorReturns true if server uses integer instead of double for binary date and time encodings.- Returns:
- the server integer_datetime setting.
-