Diffusion .NET Client Library
6.1.5
|
The configured query. More...
Public Member Functions | |
Task< IQueryResult< TValue > > | SelectFromAsync (string topicPath) |
Evaluates this query for a time series topic. More... | |
Task< IQueryResult< TValue > > | SelectFromAsync (string topicPath, CancellationToken cancellationToken) |
Evaluates this query for a time series topic. More... | |
The configured query.
A default query that performs a value range query of an entire time series can be obtained using ITimeSeries.RangeQuery and further configured using methods of the IRangeQuery{TValue} interface.
Added in version 6.1.
TValue | The query value type. |
Task<IQueryResult<TValue> > PushTechnology.ClientInterface.Client.Features.TimeSeries.IQuery< TValue >.SelectFromAsync | ( | string | topicPath | ) |
Evaluates this query for a time series topic.
The calling session must have the Types.TopicPermission.READ_TOPIC topic permission for topicPath to evaluate the query. The Types.TopicPermission.QUERY_OBSOLETE_TIME_SERIES_EVENTS topic permission is also required if this is an IRangeQuery{TValue}.ForEdits range query, or a IRangeQuery{TValue}.ForValues range query with an IRangeQuery{TValue}.EditRange.
If the operation completes successfully, the Task
result will be the IQueryResult{TValue} of the requested selection.
This method is the same as calling SelectFromAsync(string, CancellationToken) with CancellationToken.None.
topicPath | The path of the time series topic to query. |
Task
representing the current operation.ArgumentNullException | topicPath is null . |
NoSuchTopicException | There is no topic bound to topicPath . Thrown by the returned Task . |
IncompatibleTopicException | The TValue type does not match the event data type of the time series topic bound to topicPath , or the topic bound to topicPath is not a time series topic. Thrown by the returned Task . |
InvalidQueryException | The range query is not valid for the time series. Thrown by the returned Task . |
SessionSecurityException | The calling session does not have Types.TopicPermission.READ_TOPIC permission for topicPath . The calling session does not have Types.TopicPermission.QUERY_OBSOLETE_TIME_SERIES_EVENTS permission for topicPath and this is an IRangeQuery{TValue}.ForEdits range query, or a IRangeQuery{TValue}.ForValues range query with an IRangeQuery{TValue}.EditRange. Thrown by the returned Task . |
SessionClosedException | The calling session is closed. Thrown by the returned Task . |
Task<IQueryResult<TValue> > PushTechnology.ClientInterface.Client.Features.TimeSeries.IQuery< TValue >.SelectFromAsync | ( | string | topicPath, |
CancellationToken | cancellationToken | ||
) |
Evaluates this query for a time series topic.
The calling session must have the Types.TopicPermission.READ_TOPIC topic permission for topicPath to evaluate the query. The Types.TopicPermission.QUERY_OBSOLETE_TIME_SERIES_EVENTS topic permission is also required if this is an IRangeQuery{TValue}.ForEdits range query, or a IRangeQuery{TValue}.ForValues range query with an IRangeQuery{TValue}.EditRange.
If the operation completes successfully, the Task
result will be the IQueryResult{TValue} of the requested selection.
topicPath | The path of the time series topic to query. |
cancellationToken | The cancellation token used to cancel the current operation. |
Task
representing the current operation.ArgumentNullException | topicPath is null . |
NoSuchTopicException | There is no topic bound to topicPath . Thrown by the returned Task . |
IncompatibleTopicException | The TValue type does not match the event data type of the time series topic bound to topicPath , or the topic bound to topicPath is not a time series topic. Thrown by the returned Task . |
InvalidQueryException | The range query is not valid for the time series. Thrown by the returned Task . |
SessionSecurityException | The calling session does not have Types.TopicPermission.READ_TOPIC permission for topicPath . The calling session does not have Types.TopicPermission.QUERY_OBSOLETE_TIME_SERIES_EVENTS permission for topicPath and this is an IRangeQuery{TValue}.ForEdits range query, or a IRangeQuery{TValue}.ForValues range query with an IRangeQuery{TValue}.EditRange. Thrown by the returned Task . |
SessionClosedException | The calling session is closed. Thrown by the returned Task . |