VMware GemFire Native Client C++ API Reference
|
VMware VMware GemFire Native C++ Reference 10.4.3
|
A Query is obtained from a QueryService which in turn is obtained from the Cache. More...
#include <Query.hpp>
Public Member Functions | |
| virtual void | compile ()=0 |
| Compile the Query - client side query compilation is not supported. | |
| virtual std::shared_ptr< SelectResults > | execute (std::chrono::milliseconds timeout=DEFAULT_QUERY_RESPONSE_TIMEOUT)=0 |
| Executes the OQL Query on the cache server and returns the results. | |
| virtual std::shared_ptr< SelectResults > | execute (std::shared_ptr< CacheableVector > paramList, std::chrono::milliseconds timeout=DEFAULT_QUERY_RESPONSE_TIMEOUT)=0 |
| Executes the parameterized OQL Query on the cache server and returns the results. | |
| virtual const std::string & | getQueryString () const =0 |
| Get the query string provided when a new Query was created from a QueryService. | |
| virtual bool | isCompiled ()=0 |
| Check whether the Query is compiled - client side query compilation is not supported. | |
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.
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()
|
pure virtual |
Compile the Query - client side query compilation is not supported.
- Exceptions
-
UnsupportedOperationException because this is not currently supported.
◆ execute() [1/2]
|
pure virtual |
Executes the OQL Query on the cache server and returns the results.
- Parameters
-
timeout The time to wait for query response, optional.
- Exceptions
-
IllegalArgumentException If timeout exceeds 2147483647ms. QueryException 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.
- Returns
- A smart pointer to the SelectResults which can either be a ResultSet or a StructSet.
◆ execute() [2/2]
|
pure virtual |
Executes the parameterized OQL Query on the cache server and returns the results.
- Parameters
-
paramList The query parameters list timeout The time to wait for query response, optional.
- Exceptions
-
IllegalArgumentException If timeout exceeds 2147483647ms. QueryException 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. returns A smart pointer to the SelectResults which can either be a ResultSet or a StructSet.
◆ getQueryString()
|
pure virtual |
Get the query string provided when a new Query was created from a QueryService.
- Returns
- The query string.
◆ isCompiled()
|
pure virtual |
Check whether the Query is compiled - client side query compilation is not supported.
- Exceptions
-
UnsupportedOperationException because this is not currently supported.
Apache Geode C++ Cache API Documentation