CqQuery(TKey, TResult) Class

CqQueryTKey, TResult Class

Class to encapsulate a continuous query (CQ).

Inheritance Hierarchy

SystemObject
[T:GemStone.GemFire.Cache.Generic.Internal.SBWrap<gemfire::CqQuery>]
GemStone.GemFire.Cache.GenericCqQueryTKey, TResult

Namespace: GemStone.GemFire.Cache.Generic
Assembly: Gemstone.Gemfire.Cache (in Gemstone.Gemfire.Cache.dll) Version: 9.0.6.18

Syntax

C++

Copy

public sealed class CqQuery<TKey, TResult> : [T:GemStone.GemFire.Cache.Generic.Internal.SBWrap<gemfire::CqQuery>]

Public NotInheritable Class CqQuery(Of TKey, TResult)
	Inherits [T:GemStone.GemFire.Cache.Generic.Internal.SBWrap<gemfire::CqQuery>]

generic<typename TKey, typename TResult>
public ref class CqQuery sealed : public [T:GemStone.GemFire.Cache.Generic.Internal.SBWrap<gemfire::CqQuery>]

[<SealedAttribute>]
type CqQuery<'TKey, 'TResult> =  
    class
        inherit [T:GemStone.GemFire.Cache.Generic.Internal.SBWrap<gemfire::CqQuery>]
    end

Type Parameters

TKey
TResult

The CqQueryTKey, TResult type exposes the following members.

Properties

	Name	Description
	Name	Get the name for this cq query.
	QueryString	Get the string for this cq query.

Top

Methods

	Name	Description
	Close	stop the cq query
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Execute	Executes the Cq Query on the cache server
	ExecuteWithInitialResults	Executes the Cq Query on the cache server and returns the Cqresults.
	ExecuteWithInitialResults(UInt32)	Executes the Cq Query on the cache server with the specified timeout and returns the results.
	GetCqAttributes	Get the Attributes for this cq query.
	GetCqAttributesMutator	Get the Attributes Mutator for this cq query.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetQuery	Get the Query for this cq query.
	GetState	get the state of this cq query
	GetStatistics	Get the stats for this cq query.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsClosed	Is this Cq in closed state?
	IsRunning	Is this Cq in running state?
	IsStopped	Is this Cq in stopped state?
	Stop	stop the cq query
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

A CqQuery 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.

Reference

GemStone.GemFire.Cache.Generic Namespace