{NOTE: }
-
When querying via
session.Query
for documents that contain time series,
you can request to include their time series data in the server response. -
The included time series data is stored within the session
and can be provided instantly when requested without any additional server calls. -
In this page:
{NOTE/}
{PANEL: Include time series when making a query}
In this example, we retrieve a document using session.Query
and include entries from the document's "HeartRates" time series.
{CODE timeseries_region_Query-Document-And-Include-TimeSeries@DocumentExtensions\TimeSeries\TimeSeriesTests.cs /}
{PANEL/}
{PANEL: Syntax}
Include
builder methods:
{CODE IncludeTimeSeries-definition@DocumentExtensions\TimeSeries\TimeSeriesTests.cs /}
Parameter | Type | Description |
---|---|---|
name | string |
Time series Name. |
from | DateTime? |
Time series range start (inclusive). Default: DateTime.MinValue . |
to | DateTime? |
Time series range end (inclusive). Default: DateTime.MaxValue . |
{PANEL/}
Client API
Time Series API Overview
Studio Articles
Studio Time Series Management
Querying and Indexing
Time Series Querying
Time Series Indexing
Policies
Time Series Rollup and Retention