VMware GemFire Native Client .NET Framework API Reference
|
VMware VMware GemFire Native .NET Reference 10.4.3
|
Loading...
Searching...
No Matches
Apache::Geode::Client::Query< TResult > Class Template Reference
Class to encapsulate a query. More...
#include <Query.hpp>
Public Member Functions | |
| void | Compile () |
| Compile the given query – NOT IMPLEMENTED. | |
| ISelectResults< TResult > ^ | Execute () |
| Executes the OQL Query on the cache server and returns the results. | |
| ISelectResults< TResult > ^ | Execute (array< Object^>^ paramList) |
| Executes the OQL Parameterized Query on the cache server with the specified paramList and returns the results. | |
| ISelectResults< TResult > ^ | Execute (array< Object^>^ paramList, TimeSpan timeout) |
| Executes the OQL Parameterized Query on the cache server with the specified paramList & timeout parameters and returns the results. | |
| ISelectResults< TResult > ^ | Execute (TimeSpan timeout) |
| Executes the OQL Query on the cache server with the specified timeout and returns the results. | |
Properties | |
| bool | IsCompiled [get] |
| Check if the query is compiled – NOT IMPLEMENTED. | |
| String^ | QueryString [get] |
| Get the string for this query. | |
Detailed Description
template<class TResult>
class Apache::Geode::Client::Query< TResult >
class Apache::Geode::Client::Query< TResult >
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.
Member Function Documentation
◆ Compile()
template<class TResult >
| void Apache::Geode::Client::Query< TResult >::Compile | ( | ) |
Compile the given query – NOT IMPLEMENTED.
◆ Execute() [1/4]
template<class TResult >
| ISelectResults< TResult > ^ Apache::Geode::Client::Query< TResult >::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.
◆ Execute() [2/4]
template<class TResult >
| ISelectResults< TResult > ^ Apache::Geode::Client::Query< TResult >::Execute | ( | array< Object^>^ | paramList | ) |
Executes the OQL Parameterized Query on the cache server with the specified paramList and returns the results.
The default timeout for the query is 15 secs.
- Parameters
-
paramList The Parameter List for the specified Query.
- 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.
◆ Execute() [3/4]
template<class TResult >
| ISelectResults< TResult > ^ Apache::Geode::Client::Query< TResult >::Execute | ( | array< Object^>^ | paramList, |
| TimeSpan | timeout | ||
| ) |
Executes the OQL Parameterized Query on the cache server with the specified paramList & timeout parameters and returns the results.
- Parameters
-
paramList The Parameter List for the specified Query. timeout The time to wait for query response.
- Exceptions
-
IllegalArgumentException if timeout parameter is too long. 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.
◆ Execute() [4/4]
template<class TResult >
| ISelectResults< TResult > ^ Apache::Geode::Client::Query< TResult >::Execute | ( | TimeSpan | timeout | ) |
Executes the OQL Query on the cache server with the specified timeout and returns the results.
- Parameters
-
timeout The time to wait for query response.
- 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.
Property Documentation
◆ IsCompiled
template<class TResult >
|
get |
Check if the query is compiled – NOT IMPLEMENTED.
◆ QueryString
template<class TResult >
|
get |
Get the string for this query.
Apache Geode C++ Cache .NET API Documentation