VMware GemFire Native Client C++ API Reference
|
VMware VMware GemFire Native C++ Reference 10.4.3
|
Loading...
Searching...
No Matches
apache::geode::client::QueryService Class Referenceabstract
QueryService is the class obtained from a Cache. More...
#include <QueryService.hpp>
Public Member Functions | |
| virtual void | closeCqs ()=0 |
| Close all CQs, and release resources associated with executing CQs. | |
| virtual void | executeCqs ()=0 |
| @nativeclient Executes all the cqs on this client. | |
| virtual std::shared_ptr< CacheableArrayList > | getAllDurableCqsFromServer () const =0 |
| Gets all the durable CQs registered by this client. | |
| virtual std::shared_ptr< CqQuery > | getCq (const std::string &name) const =0 |
| Retrieve a CqQuery by name. | |
| virtual query_container_type | getCqs () const =0 |
| @nativeclient Retrieve all registered CQs @endnativeclient | |
| virtual std::shared_ptr< CqServiceStatistics > | getCqServiceStatistics () const =0 |
| @nativeclient Get statistics information for all CQs | |
| virtual std::shared_ptr< CqQuery > | newCq (std::string name, std::string querystr, const std::shared_ptr< CqAttributes > &cqAttr, bool isDurable=false)=0 |
| Constructs a new named continuous query, represented by an instance of CqQuery. | |
| virtual std::shared_ptr< CqQuery > | newCq (std::string querystr, const std::shared_ptr< CqAttributes > &cqAttr, bool isDurable=false)=0 |
| @nativeclient Constructs a new named continuous query, represented by an instance of CqQuery. | |
| virtual std::shared_ptr< Query > | newQuery (std::string querystr)=0 |
| Get a new Query with the specified query string. | |
| virtual void | stopCqs ()=0 |
| Stops all the cqs on this client. | |
Detailed Description
QueryService is the class obtained from a Cache.
A Query is created from a QueryService and executed on the server returning a SelectResults which can be either a ResultSet or a StructSet.
Member Function Documentation
◆ closeCqs()
|
pure virtual |
Close all CQs, and release resources associated with executing CQs.
◆ executeCqs()
|
pure virtual |
@nativeclient Executes all the cqs on this client.
@endnativeclient
◆ getAllDurableCqsFromServer()
|
pure virtual |
Gets all the durable CQs registered by this client.
- Returns
- List of names of registered durable CQs, empty list if no durable cqs.
◆ getCq()
|
pure virtual |
◆ getCqs()
|
pure virtual |
@nativeclient Retrieve all registered CQs @endnativeclient
◆ getCqServiceStatistics()
|
pure virtual |
@nativeclient Get statistics information for all CQs
- Returns
- the CqServiceStatistics @endnativeclient
◆ newCq() [1/2]
|
pure virtual |
Constructs a new named continuous query, represented by an instance of CqQuery.
The CqQuery is not executed, however, until the execute method is invoked on the CqQuery. The name of the query will be used to identify this query in statistics archival.
- Parameters
-
name the String name for this query querystr the OQL query cqAttr the CqAttributes isDurable true if the CQ is durable
- Returns
- the newly created CqQuery object
- Exceptions
-
CqExistsException if a CQ by this name already exists on this client IllegalArgumentException if queryString is null, or cqAttr is nullptr IllegalStateException if this method is called from a cache server QueryInvalidException if there is a syntax error in the query CqException if failed to create cq, failure during creating managing cq metadata info. CqInvalidException if the query doesnot meet the CQ constraints. E.g.: Query string should refer only one region, join not supported. The query must be a SELECT statement. DISTINCT queries are not supported. Projections are not supported. Only one iterator in the FROM clause is supported, and it must be a region path. Bind parameters in the query are not supported for the initial release.
◆ newCq() [2/2]
|
pure virtual |
@nativeclient Constructs a new named continuous query, represented by an instance of CqQuery.
The CqQuery is not executed, however, until the execute method is invoked on the CqQuery. The name of the query will be used to identify this query in statistics archival.
- Parameters
-
querystr the OQL query cqAttr the CqAttributes isDurable true if the CQ is durable
- Returns
- the newly created CqQuery object
- Exceptions
-
CqExistsException if a CQ by this name already exists on this client IllegalArgumentException if queryString is null, or cqAttr is nullptr IllegalStateException if this method is called from a cache server QueryInvalidException if there is a syntax error in the query CqException if failed to create cq, failure during creating managing cq metadata info. CqInvalidException if the query doesnot meet the CQ constraints. E.g.: Query string should refer only one region, join not supported. The query must be a SELECT statement. DISTINCT queries are not supported. Projections are not supported. Only one iterator in the FROM clause is supported, and it must be a region path. Bind parameters in the query are not supported for the initial release.
@endnativeclient
◆ newQuery()
|
pure virtual |
◆ stopCqs()
|
pure virtual |
Stops all the cqs on this client.
Apache Geode C++ Cache API Documentation