GemStone::GemFire::Cache::Query Class Reference

---

Detailed Description

Class to encapsulate a query.

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.

This class is intentionally not thread-safe. So multiple threads should not operate on the same Query object concurrently rather should have their own Query objects.

Public Member Functions
void	Compile ()
ISelectResults^	Execute (uint32_t timeout)
ISelectResults^	Execute ()
Properties
bool	IsCompiled [get]
String^	QueryString [get]

---

Member Function Documentation

void GemStone::GemFire::Cache::Query::Compile

(

)

Compile the given query -- NOT IMPLEMENTED.

ISelectResults ^ GemStone::GemFire::Cache::Query::Execute

(

uint32_t

timeout

)

Executes the OQL Query on the cache server with the specified timeout and returns the results.

Parameters:

timeout

The time (in seconds) to wait for query response. 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.
	QueryException	if some query error occurred at the server.
	IllegalStateException	if some other error occurred.
	NotConnectedException	if no java cache server is available For pools configured with locators, if no locators are available, innerException of NotConnectedException is set to NoAvailableLocatorsException.

Returns:

An ISelectResults object which can either be a ResultSet or a StructSet.

ISelectResults ^ GemStone::GemFire::Cache::Query::Execute

(

)

Executes the OQL Query on the cache server and returns the results. The default timeout for the query is 15 secs.

Exceptions:

	QueryException	if some query error occurred at the server.
	IllegalStateException	if some other error occurred.
	NotConnectedException	if no java cache server is available. For pools configured with locators, if no locators are available, innerException of NotConnectedException is set to NoAvailableLocatorsException.

Returns:

An ISelectResults object which can either be a ResultSet or a StructSet.

---

Property Documentation

bool GemStone::GemFire::Cache::Query::IsCompiled [get]

Check if the query is compiled -- NOT IMPLEMENTED.

String^ GemStone::GemFire::Cache::Query::QueryString [get]

Get the string for this query.

---