This can be executed to return SelectResults which can be either a ResultSet or a StructSet, or it can be just registered on the java server without returning results immediately rather only the incremental results.
This class is intentionally not thread-safe. So multiple threads should not operate on the same CqQuery object concurrently rather should have their own CqQuery objects.
Public Member Functions | |
| virtual void | close ()=0 |
| Close the CQ and stop execution. | |
| virtual void | execute ()=0 |
| Executes the OQL Query on the cache server and returns the results. | |
| virtual CqResultsPtr | executeWithInitialResults (uint32_t timeout=DEFAULT_QUERY_RESPONSE_TIMEOUT)=0 |
| Start executing the CQ or if this CQ is stopped earlier, resumes execution of the CQ. | |
| virtual const CqAttributesPtr | getCqAttributes () const =0 |
| Get the Attributes of this CQ. | |
| virtual const CqAttributesMutatorPtr | getCqAttributesMutator () const =0 |
| Get the AttributesMutator of this CQ. | |
| virtual const char * | getName () const =0 |
| Get the name of the CQ. | |
| virtual QueryPtr | getQuery () const =0 |
| Get teh query object generated for this CQs query. | |
| virtual const char * | getQueryString () const =0 |
| Get the query string provided when a new Query was created from a QueryService. | |
| virtual CqState::StateType | getState ()=0 |
| Get the state of the CQ in CqState object form. | |
| virtual const CqStatisticsPtr | getStatistics () const =0 |
| Get the statistics information of this CQ. | |
| virtual bool | isClosed ()=0 |
| This allows to check if the CQ is closed. | |
| virtual bool | isDurable ()=0 |
| This allows to check if the CQ is durable. | |
| virtual bool | isRunning ()=0 |
| This allows to check if the CQ is in running or active. | |
| virtual bool | isStopped ()=0 |
| This allows to check if the CQ is in stopped. | |
| void | preserveSB () const |
| Atomically increment reference count. | |
| int32_t | refCount () |
| |
| void | releaseSB () const |
| Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero. | |
| virtual void | stop ()=0 |
| Stops this CqQuery without releasing resources. | |
| virtual void gemfire::CqQuery::close | ( | ) | [pure virtual] |
Close the CQ and stop execution.
Releases the resources associated with this CqQuery.
| CqClosedException | Further calls on this CqQuery instance except for getState() or getName(). | |
| CqException | - if failure during cleanup of CQ resources. |
| virtual void gemfire::CqQuery::execute | ( | ) | [pure virtual] |
Executes the OQL Query on the cache server and returns the results.
| RegionNotFoundException | if the specified region in the query string is not found. | |
| CqClosedException | if this CqQuery is closed. | |
| CqException | if some query error occurred at the server. | |
| IllegalStateException | if some error occurred. | |
| NotConnectedException | if no java cache server is available. For pools configured with locators, if no locators are available, the cause of NotConnectedException is set to NoAvailableLocatorsException. |
| virtual CqResultsPtr gemfire::CqQuery::executeWithInitialResults | ( | uint32_t | timeout = DEFAULT_QUERY_RESPONSE_TIMEOUT |
) | [pure virtual] |
Start executing the CQ or if this CQ is stopped earlier, resumes execution of the CQ.
Get the resultset associated with CQ query. The CQ is executed on primary and redundant servers, if CQ execution fails on all the server then a CqException is thrown.
| timeout | The time (in seconds) to wait for query response, optional. This should be less than or equal to 2^31/1000 i.e. 2147483. |
| IllegalArgumentException | if timeout parameter is greater than 2^31/1000. | |
| CqClosedException | if this CqQuery is closed. | |
| RegionNotFoundException | if the specified region in the query string is not found. | |
| IllegalStateException | if the CqQuery is in the RUNNING state already. | |
| CqException | if failed to execute and get initial results. |
| virtual const CqAttributesPtr gemfire::CqQuery::getCqAttributes | ( | ) | const [pure virtual] |
| virtual const CqAttributesMutatorPtr gemfire::CqQuery::getCqAttributesMutator | ( | ) | const [pure virtual] |
| virtual const char* gemfire::CqQuery::getName | ( | ) | const [pure virtual] |
Get the name of the CQ.
| virtual QueryPtr gemfire::CqQuery::getQuery | ( | ) | const [pure virtual] |
| virtual const char* gemfire::CqQuery::getQueryString | ( | ) | const [pure virtual] |
Get the query string provided when a new Query was created from a QueryService.
| virtual CqState::StateType gemfire::CqQuery::getState | ( | ) | [pure virtual] |
Get the state of the CQ in CqState object form.
CqState supports methods like isClosed(), isRunning(), isStopped().
| virtual const CqStatisticsPtr gemfire::CqQuery::getStatistics | ( | ) | const [pure virtual] |
| virtual bool gemfire::CqQuery::isClosed | ( | ) | [pure virtual] |
This allows to check if the CQ is closed.
| virtual bool gemfire::CqQuery::isDurable | ( | ) | [pure virtual] |
This allows to check if the CQ is durable.
| virtual bool gemfire::CqQuery::isRunning | ( | ) | [pure virtual] |
This allows to check if the CQ is in running or active.
| virtual bool gemfire::CqQuery::isStopped | ( | ) | [pure virtual] |
This allows to check if the CQ is in stopped.
| void gemfire::SharedBase::preserveSB | ( | ) | const [inherited] |
Atomically increment reference count.
| int32_t gemfire::SharedBase::refCount | ( | ) | [inline, inherited] |
| void gemfire::SharedBase::releaseSB | ( | ) | const [inherited] |
Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero.
| virtual void gemfire::CqQuery::stop | ( | ) | [pure virtual] |