A Query is obtained from a QueryService which in turn is obtained from the Cache. More...

Inherits apache::geode::client::SharedBase.

Public Member Functions
virtual void	close ()=0
	Close the CQ and stop execution. More...

virtual void	execute ()=0
	Executes the OQL Query on the cache server and returns the results. More...

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. More...

virtual const CqAttributesPtr	getCqAttributes () const =0
	Get the Attributes of this CQ. More...

virtual const CqAttributesMutatorPtr	getCqAttributesMutator () const =0
	Get the AttributesMutator of this CQ. More...

virtual const char *	getName () const =0
	Get the name of the CQ. More...

virtual QueryPtr	getQuery () const =0
	Get teh query object generated for this CQs query. More...

virtual const char *	getQueryString () const =0
	Get the query string provided when a new Query was created from a QueryService. More...

virtual CqState::StateType	getState ()=0
	Get the state of the CQ in CqState object form. More...

virtual const CqStatisticsPtr	getStatistics () const =0
	Get the statistics information of this CQ. More...

virtual bool	isClosed ()=0
	This allows to check if the CQ is closed. More...

virtual bool	isDurable ()=0
	This allows to check if the CQ is durable. More...

virtual bool	isRunning ()=0
	This allows to check if the CQ is in running or active. More...

virtual bool	isStopped ()=0
	This allows to check if the CQ is in stopped. More...

void	preserveSB () const
	Atomically increment reference count. More...

int32_t	refCount ()

void	releaseSB () const
	Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero. More...

virtual void	stop ()=0
	Stops this CqQuery without releasing resources. More...

Detailed Description

A Query is obtained from a QueryService which in turn is obtained from the Cache.

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.

Member Function Documentation

virtual void apache::geode::client::CqQuery::close ( )

pure virtual

Close the CQ and stop execution.

Releases the resources associated with this CqQuery.

Exceptions

CqClosedException	Further calls on this CqQuery instance except for getState() or getName().
CqException	- if failure during cleanup of CQ resources.

virtual void apache::geode::client::CqQuery::execute ( )

pure virtual

Executes the OQL Query on the cache server and returns the results.

Exceptions

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 apache::geode::client::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.

Parameters

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.

Exceptions

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.

Returns: CqResults resultset obtained by executing the query.

virtual const CqAttributesPtr apache::geode::client::CqQuery::getCqAttributes ( ) const

pure virtual

Get the Attributes of this CQ.

Returns: CqAttributes, the CqAttributes object.

virtual const CqAttributesMutatorPtr apache::geode::client::CqQuery::getCqAttributesMutator ( ) const

pure virtual

Get the AttributesMutator of this CQ.

Returns: CqAttributesMutator, the CqAttributesMutator object.

virtual const char* apache::geode::client::CqQuery::getName ( ) const

pure virtual

Get the name of the CQ.

Returns: the name of the CQ.

virtual QueryPtr apache::geode::client::CqQuery::getQuery ( ) const

pure virtual

Get teh query object generated for this CQs query.

Returns: Query object fort he query string

virtual const char* apache::geode::client::CqQuery::getQueryString ( ) const

pure virtual

Get the query string provided when a new Query was created from a QueryService.

Returns: The query string.

virtual CqState::StateType apache::geode::client::CqQuery::getState ( )

pure virtual

Get the state of the CQ in CqState object form.

CqState supports methods like isClosed(), isRunning(), isStopped().

See also: CqState

Returns: CqState state object of the CQ.

virtual const CqStatisticsPtr apache::geode::client::CqQuery::getStatistics ( ) const

pure virtual

Get the statistics information of this CQ.

Returns: CqStatistics, the CqStatistics object.

virtual bool apache::geode::client::CqQuery::isClosed ( )

pure virtual

This allows to check if the CQ is closed.

Returns: boolean true if closed, false otherwise

virtual bool apache::geode::client::CqQuery::isDurable ( )

pure virtual

This allows to check if the CQ is durable.

Returns: boolean true if durable, false otherwise

Since: 5.5

virtual bool apache::geode::client::CqQuery::isRunning ( )

pure virtual

This allows to check if the CQ is in running or active.

Returns: boolean true if running, false otherwise

virtual bool apache::geode::client::CqQuery::isStopped ( )

pure virtual

This allows to check if the CQ is in stopped.

Returns: boolean true if stopped, false otherwise

void apache::geode::client::SharedBase::preserveSB ( ) const

inherited

Atomically increment reference count.

int32_t apache::geode::client::SharedBase::refCount ( )

inlineinherited

Returns: the reference count

void apache::geode::client::SharedBase::releaseSB ( ) const

inherited

Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero.

virtual void apache::geode::client::CqQuery::stop ( )

pure virtual

Stops this CqQuery without releasing resources.

Puts the CqQuery into the STOPPED state. Can be resumed by calling execute or executeWithInitialResults.

Exceptions

IllegalStateException	if the CqQuery is in the STOPPED state already.
CqClosedException	if the CQ is CLOSED.

Public Member Functions

Detailed Description

Member Function Documentation