A time series is constructed of time series entries, which can
be created and deleted using the API.
There is no need to explicitly create or delete a time series.
A time series is created when the first entry is appended to it.
A time series is deleted when all entries are deleted from it.
session Methods -vs- document-store Operations
Some time series functions are available through both session methods
and document-store operations:
You can append, delete, get and patch time series data
through both interfaces.
There are also functionalities unique to each interface.
Time series functionalities unique to the sessioninterface:
session methods provide a transactional guarantee.
Use them when you want to guarantee that your actions would
be processed in a single ACID transaction.
You can, for instance, gather multiple session actions
(e.g. the update of a time series and the modification
of a document) and execute them in a single transaction
by calling session.SaveChanges, to ensure that they
would all be completed or all be reverted.
You can use session methods to include time series while
Included time series data is held by the client's session,
and can be handed to the user instantly when requested
without issuing an additional request to the server
Time series functionalities unique to the storeinterface:
Getting the data of multiple time series in a single operation.
Managing time series rollup and retention policies.
Patching time series data to multiple documents located by a query.
Available Time Series session methods
Use this method to Append entries to a time series
(creating the series if it didn't previously exist).
Use this method to delete a range of entries from a time series
(removing the series completely if all entries have been deleted).
Use this method to Retrieve raw time series entries
for all entries or for a chosen entries range.
Use this method to Retrieve time series Names.
Series names are fetched by GetTimeSeriesFor directly from their parent documents'
metadata, requiring no additional server roundtrips.