VMware Tanzu GemFire .NET Client API Reference
|
VMware Tanzu GemFire .NET Client
|
|
Class to encapsulate a remote query. More...
Inherited by Query< TResult >.
Public Member Functions | |
| IReadOnlyCollection< TResult > | Execute () |
| Executes the OQL Query on the cache server and returns the results. The default timeout for the query is 15 secs. More... | |
| IReadOnlyCollection< TResult > | Execute (TimeSpan timeout) |
| Executes the OQL Query on the cache server with the specified timeout and returns the results. More... | |
| IReadOnlyCollection< TResult > | Execute (IReadOnlyCollection< object > paramList, TimeSpan timeout) |
| Executes the OQL Parameterized Query on the cache server with the specified paramList and timeout parameters and returns the results. More... | |
| IReadOnlyCollection< TResult > | Execute (IReadOnlyCollection< 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. More... | |
Properties | |
| string | QueryString [get] |
| Property to get the string used for this query. More... | |
Detailed Description
Class to encapsulate a remote query.
A Query is obtained from a QueryService which in turn is obtained from the Cache via GetQueryService(). This can be executed to return ListTResult .
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
◆ Execute() [1/4]
| IReadOnlyCollection<TResult> IQuery< TResult >.Execute | ( | ) |
Executes the OQL Query on the cache server and returns the results. The default timeout for the query is 15 secs.
- Exceptions
-
GemFireIllegalArgumentException if query string is null or empty DotNetty.Transport.Channels.ConnectException if no java cache server is available.
- Returns
- IReadOnlyCollection<TResults> as List<TResult>
◆ Execute() [2/4]
| IReadOnlyCollection<TResult> IQuery< TResult >.Execute | ( | IReadOnlyCollection< 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
-
GemFireIllegalArgumentException if query string is null or empty GemFireServerException if some query error occurred at the server, in the case where query exceeded timeout this maps to org.apache.geode.cache.QueryExecutionTimeoutException. DotNetty.Transport.Channels.ConnectException if no java cache server is available
- Returns
- An IReadOnlyCollectionTResult object as ListTResult .
◆ Execute() [3/4]
| IReadOnlyCollection<TResult> IQuery< TResult >.Execute | ( | IReadOnlyCollection< object > | paramList, |
| TimeSpan | timeout | ||
| ) |
Executes the OQL Parameterized Query on the cache server with the specified paramList and timeout parameters and returns the results.
- Parameters
-
paramList The Parameter List for the specified Query. timeout The time to wait for query response.
- Exceptions
-
GemFireIllegalArgumentException if query string is null or empty GemFireServerException if some query error occurred at the server, in the case where query exceeded timeout this maps to org.apache.geode.cache.QueryExecutionTimeoutException. DotNetty.Transport.Channels.ConnectException if no java cache server is available
- Returns
- An IReadOnlyCollectionTResult object as ListTResult .
◆ Execute() [4/4]
| IReadOnlyCollection<TResult> IQuery< 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
-
GemFireIllegalArgumentException if query string is null or empty GemFireServerException if some query error occurred at the server, in the case where query exceeded timeout this maps to org.apache.geode.cache.QueryExecutionTimeoutException. DotNetty.Transport.Channels.ConnectException if no java cache server is available
- Returns
- IReadOnlyCollection<TResults> as List<TResult>
Property Documentation
◆ QueryString
|
get |
Property to get the string used for this query.
The documentation for this interface was generated from the following file:
- gemfire.client/Interfaces/IQuery.cs
- Generated by
1.8.17