Session: Overview
-
Incremental Time Series can be created and managed using a set of session API methods, whose functionality is mostly identical to that of non-incremental time series session methods.
-
The incremental time series uses the Increment method to -
- Create a new time series,
- Create a new time series entry,
- and Increase a value by some delta.
-
In this page:
Session API Methods
IncrementalTimeSeriesFor
Methods
The IncrementalTimeSeriesFor
class provides useful incremental time series
session API methods, including Increment,
Get,
and Delete.
To use it -
- Open a session
-
Create an instance of
IncrementalTimeSeriesFor
and pass it:- An explicit document ID,
-or-
An entity tracked by the session, e.g. a document object returned from session.Query or from session.Load. - The time series name.
The name must begin with "INC:" (can be upper or lower case) to identify the time series as incremental.
- An explicit document ID,
- Call an
IncrementalTimeSeriesFor
method - Call
session.SaveChanges
for the action to take place.
Additional Session Methods
Additional session API methods handle incremental time series the same way they do non-incremental time series, allowing you to -