Skip to content
Documentation

ITimeSeriesDataStore Interface

A data store to read and write time series data.

public interface ITimeSeriesDataStore

Derived
↳ ITimeSeriesDataStore<TConfiguration>
↳ ITimeSeriesQuotationDataStore
↳ ITimeSeriesQuotationDataStore<TConfiguration>

ITimeSeriesDataStore.ReadingOptions Property

Section titled “ITimeSeriesDataStore.ReadingOptions Property”

Used to create ITimeSeriesDataReadingOptions.

HAKOM.TSM.Net.Api.Data.Persistence.TimeSeries.ITimeSeriesDataReadingOptionsFactory ReadingOptions { get; }

ITimeSeriesDataReadingOptionsFactory

ITimeSeriesDataStore.SupportsRead Property

Section titled “ITimeSeriesDataStore.SupportsRead Property”

Gets a System.Boolean value indicating if the data store supports reading.

bool SupportsRead { get; }

System.Boolean

ITimeSeriesDataStore.SupportsWrite Property

Section titled “ITimeSeriesDataStore.SupportsWrite Property”

Gets a System.Boolean value indicating if the data store supports writing.

bool SupportsWrite { get; }

System.Boolean

ITimeSeriesDataStore.WritingOptions Property

Section titled “ITimeSeriesDataStore.WritingOptions Property”

Used to create ITimeSeriesDataWritingOptions.

HAKOM.TSM.Net.Api.Data.Persistence.TimeSeries.ITimeSeriesDataWritingOptionsFactory WritingOptions { get; }

ITimeSeriesDataWritingOptionsFactory

ITimeSeriesDataStore.Configure(ITimeSeriesReference, IUnitStore, IUnitConversionStore, CancellationToken) Method

Section titled “ITimeSeriesDataStore.Configure(ITimeSeriesReference, IUnitStore, IUnitConversionStore, CancellationToken) Method”

Configures the data store with the given parameters.

System.Threading.Tasks.Task Configure(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, HAKOM.TSM.Net.Api.Units.Persistence.IUnitStore unitStore, HAKOM.TSM.Net.Api.Units.Persistence.IUnitConversionStore unitConversionStore, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

timeSeriesReference ITimeSeriesReference

The ITimeSeries object for which this data store will be configured.

unitStore IUnitStore

The IUnitStore used for various conversions when reading and writing data.

unitConversionStore IUnitConversionStore

The IUnitConversionStore used for various conversions when reading and writing data.

cancellationToken System.Threading.CancellationToken

Propagates a notification if the operations should be canceled.

System.Threading.Tasks.Task

ITimeSeriesDataStore.ConfigureStorageProvider(IStorageProvider, CancellationToken) Method

Section titled “ITimeSeriesDataStore.ConfigureStorageProvider(IStorageProvider, CancellationToken) Method”

Configures the data store with the given storageProvider.

System.Threading.Tasks.Task ConfigureStorageProvider(HAKOM.Persistence.Core.Net.Api.Storage.IStorageProvider storageProvider, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

storageProvider IStorageProvider

The IStorageProvider used for read and write operations on the storage.

cancellationToken System.Threading.CancellationToken

Propagates a notification if the operations should be canceled.

System.Threading.Tasks.Task

ITimeSeriesDataStore.Delete(bool, CancellationToken) Method

Section titled “ITimeSeriesDataStore.Delete(bool, CancellationToken) Method”

Deletes all time series data.

System.Threading.Tasks.Task Delete(bool includePreviousConfigurations=false, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

includePreviousConfigurations System.Boolean

If set to true, data from previous configurations will be deleted too.

cancellationToken System.Threading.CancellationToken

Propagates a notification if the operations should be canceled.

System.Threading.Tasks.Task
A System.Threading.Tasks.Task that completes once all data of a timeseries has been deleted.

ITimeSeriesDataStore.Delete<TValue>(Period, CancellationToken) Method

Section titled “ITimeSeriesDataStore.Delete<TValue>(Period, CancellationToken) Method”

Deletes time series data in a time range.

System.Threading.Tasks.Task Delete<TValue>(HAKOM.TSM.Net.Api.Time.Periods.Period period, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IComparable<TValue>, System.IEquatable<TValue>;

TValue

The type of the values of the data points to be deleted.

period Period

The time Period from which the data will be deleted.

cancellationToken System.Threading.CancellationToken

Propagates a notification if the operations should be canceled.

System.Threading.Tasks.Task
A System.Threading.Tasks.Task that completes once all data of a timeseries has been deleted.

ITimeSeriesDataStore.Delete<TValue>(DateTimeOffset, DateTimeOffset, CancellationToken) Method

Section titled “ITimeSeriesDataStore.Delete<TValue>(DateTimeOffset, DateTimeOffset, CancellationToken) Method”

Deletes time series data in a time range.

System.Threading.Tasks.Task Delete<TValue>(System.DateTimeOffset from, System.DateTimeOffset to, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IComparable<TValue>, System.IEquatable<TValue>;

TValue

The type of the values of the data points to be deleted.

from System.DateTimeOffset

Start date of the time range in which the data will be deleted.

to System.DateTimeOffset

End date of the time range in which the data will be deleted.

cancellationToken System.Threading.CancellationToken

Propagates a notification if the operations should be canceled.

System.Threading.Tasks.Task
A System.Threading.Tasks.Task that completes once all data of a timeseries has been deleted.

ITimeSeriesDataStore.Read<TValue>(ITimeSeriesDataReadingOptions, CancellationToken) Method

Section titled “ITimeSeriesDataStore.Read<TValue>(ITimeSeriesDataReadingOptions, CancellationToken) Method”

Read data of a time series with the given reading options.

System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>> Read<TValue>(HAKOM.TSM.Net.Api.Data.Persistence.TimeSeries.ITimeSeriesDataReadingOptions readingOptions, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IComparable<TValue>, System.IEquatable<TValue>;

TValue

The type of the values of the data points to be read.

readingOptions ITimeSeriesDataReadingOptions

ITimeSeriesDataReadingOptions on how the data should be read.

cancellationToken System.Threading.CancellationToken

Propagates a notification if the operations should be canceled.

System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>>
An ITimeSeriesDataCollection<TValue> with additional information (unit, etc).

ITimeSeriesDataStore.Read<TValue>(Period, CancellationToken) Method

Section titled “ITimeSeriesDataStore.Read<TValue>(Period, CancellationToken) Method”

Read data of a time series with the given period.

System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>> Read<TValue>(HAKOM.TSM.Net.Api.Time.Periods.Period period, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IComparable<TValue>, System.IEquatable<TValue>;

TValue

The type of the values of the data points to be read.

period Period

The time Period from which to read the data.

cancellationToken System.Threading.CancellationToken

Propagates notification if the operations should be canceled.

System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>>
An ITimeSeriesDataCollection<TValue> with additional information (unit, etc).

ITimeSeriesDataStore.Read<TValue>(DateTimeOffset, DateTimeOffset, CancellationToken) Method

Section titled “ITimeSeriesDataStore.Read<TValue>(DateTimeOffset, DateTimeOffset, CancellationToken) Method”

Read data of a time series with the given from and to parameters.

System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>> Read<TValue>(System.DateTimeOffset from, System.DateTimeOffset to, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IComparable<TValue>, System.IEquatable<TValue>;

TValue

The type of the values of the data points to be read.

from System.DateTimeOffset

The start time of the reading period.

to System.DateTimeOffset

The end time of the reading period.

cancellationToken System.Threading.CancellationToken

Propagates notification if the operations should be canceled.

System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>>
An ITimeSeriesDataCollection<TValue> with additional information (unit, etc).

ITimeSeriesDataStore.ReadAuditLogEntries(Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<Period>, Nullable<int>, CancellationToken) Method

Section titled “ITimeSeriesDataStore.ReadAuditLogEntries(Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<Period>, Nullable<int>, CancellationToken) Method”

Reads the audit log entries of a time series.

System.Collections.Generic.IAsyncEnumerable<HAKOM.TSM.Net.Api.Data.Persistence.TimeSeries.IAuditLogEntry> ReadAuditLogEntries(System.Nullable<System.DateTimeOffset> modifiedSince, System.Nullable<System.DateTimeOffset> modifiedUntil, System.Nullable<HAKOM.TSM.Net.Api.Time.Periods.Period> dataPeriod, System.Nullable<int> limit=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

modifiedSince System.Nullable<System.DateTimeOffset>

Filters the audit log entries so that only audit logs written after this date are returned.

modifiedUntil System.Nullable<System.DateTimeOffset>

Filters the audit log entries so that only audit logs written before this date are returned.

dataPeriod System.Nullable<Period>

Specifies the time frame of the data for which audit logs are searched. Only audit logs affecting data within this period are returned.

limit System.Nullable<System.Int32>

Limits the number of returned audit log entries to the specified maximum.

cancellationToken System.Threading.CancellationToken

Propagates a notification if the operation should be canceled.

System.Collections.Generic.IAsyncEnumerable<IAuditLogEntry>
An System.Collections.Generic.IAsyncEnumerable<> containing the filtered audit log entries.

ITimeSeriesDataStore.TryDelete(bool, CancellationToken) Method

Section titled “ITimeSeriesDataStore.TryDelete(bool, CancellationToken) Method”

Try delete all time series data.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result> TryDelete(bool includePreviousConfigurations=false, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

includePreviousConfigurations System.Boolean

If set to true, data from previous configurations will be deleted too.

cancellationToken System.Threading.CancellationToken

Propagates a notification if the operations should be canceled.

System.Threading.Tasks.Task<Result>
A System.Threading.Tasks.Task<> that completes once all data of a timeseries has been deleted and containing a Result with information about success or failure of the operation.

ITimeSeriesDataStore.TryDelete<TValue>(Period, CancellationToken) Method

Section titled “ITimeSeriesDataStore.TryDelete<TValue>(Period, CancellationToken) Method”

Try to delete time series data in a time range.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result> TryDelete<TValue>(HAKOM.TSM.Net.Api.Time.Periods.Period period, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IComparable<TValue>, System.IEquatable<TValue>;

TValue

The type of the values of the data points to be deleted.

period Period

The time Period from which the data will be deleted.

cancellationToken System.Threading.CancellationToken

Propagates a notification if the operations should be canceled.

System.Threading.Tasks.Task<Result>
A System.Threading.Tasks.Task<> that completes once all data of a timeseries has been deleted and containing a Result with information about success or failure of the operation.

ITimeSeriesDataStore.TryDelete<TValue>(DateTimeOffset, DateTimeOffset, CancellationToken) Method

Section titled “ITimeSeriesDataStore.TryDelete<TValue>(DateTimeOffset, DateTimeOffset, CancellationToken) Method”

Try to delete time series data in a time range.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result> TryDelete<TValue>(System.DateTimeOffset from, System.DateTimeOffset to, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IComparable<TValue>, System.IEquatable<TValue>;

TValue

The type of the values of the data points to be deleted.

from System.DateTimeOffset

Start date of the time range in which the data will be deleted.

to System.DateTimeOffset

End date of the time range in which the data will be deleted.

cancellationToken System.Threading.CancellationToken

Propagates a notification if the operations should be canceled.

System.Threading.Tasks.Task<Result>
A System.Threading.Tasks.Task<> that completes once all data of a timeseries has been deleted and containing a Result with information about success or failure of the operation.

ITimeSeriesDataStore.TryRead<TValue>(ITimeSeriesDataReadingOptions, CancellationToken) Method

Section titled “ITimeSeriesDataStore.TryRead<TValue>(ITimeSeriesDataReadingOptions, CancellationToken) Method”

Try to read data of a time series with the given reading options.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>>> TryRead<TValue>(HAKOM.TSM.Net.Api.Data.Persistence.TimeSeries.ITimeSeriesDataReadingOptions readingOptions, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IComparable<TValue>, System.IEquatable<TValue>;

TValue

The type of the values of the data points to be read.

readingOptions ITimeSeriesDataReadingOptions

ITimeSeriesDataReadingOptions on how the data should be read.

cancellationToken System.Threading.CancellationToken

Propagates a notification if the operations should be canceled.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>>>
A System.Threading.Tasks.Task<> of Result<TValue> containing the created ITimeSeriesDataCollection<TValue> with additional information (unit, etc).

The Result will provide additional information about success or failure.

ITimeSeriesDataStore.TryRead<TValue>(Period, CancellationToken) Method

Section titled “ITimeSeriesDataStore.TryRead<TValue>(Period, CancellationToken) Method”

Try to read data of a time series with the given period.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>>> TryRead<TValue>(HAKOM.TSM.Net.Api.Time.Periods.Period period, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IComparable<TValue>, System.IEquatable<TValue>;

TValue

The type of the values of the data points to be read.

period Period

The time Period from which to read the data.

cancellationToken System.Threading.CancellationToken

Propagates notification if the operations should be canceled.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>>>
A System.Threading.Tasks.Task<> of Result<TValue> containing the created ITimeSeriesDataCollection<TValue> with additional information (unit, etc).

The Result will provide additional information about success or failure.

ITimeSeriesDataStore.TryRead<TValue>(DateTimeOffset, DateTimeOffset, CancellationToken) Method

Section titled “ITimeSeriesDataStore.TryRead<TValue>(DateTimeOffset, DateTimeOffset, CancellationToken) Method”

Try to read data of a time series with the given from and to parameters.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>>> TryRead<TValue>(System.DateTimeOffset from, System.DateTimeOffset to, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IComparable<TValue>, System.IEquatable<TValue>;

TValue

The type of the values of the data points to be read.

from System.DateTimeOffset

The start time of the reading period.

to System.DateTimeOffset

The end time of the reading period.

cancellationToken System.Threading.CancellationToken

Propagates notification if the operations should be canceled.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>>>
A System.Threading.Tasks.Task<> of Result<TValue> containing the created ITimeSeriesDataCollection<TValue> with additional information (unit, etc).

The Result will provide additional information about success or failure.

ITimeSeriesDataStore.TryReadAuditLogEntries(Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<Period>, Nullable<int>, CancellationToken) Method

Section titled “ITimeSeriesDataStore.TryReadAuditLogEntries(Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<Period>, Nullable<int>, CancellationToken) Method”

Try reading the audit log entries of a time series.

System.Collections.Generic.IAsyncEnumerable<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Data.Persistence.TimeSeries.IAuditLogEntry>> TryReadAuditLogEntries(System.Nullable<System.DateTimeOffset> modifiedSince, System.Nullable<System.DateTimeOffset> modifiedUntil, System.Nullable<HAKOM.TSM.Net.Api.Time.Periods.Period> dataPeriod, System.Nullable<int> limit=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

modifiedSince System.Nullable<System.DateTimeOffset>

Filters the audit log entries so that only audit logs written after this date are returned.

modifiedUntil System.Nullable<System.DateTimeOffset>

Filters the audit log entries so that only audit logs written before this date are returned.

dataPeriod System.Nullable<Period>

Specifies the time frame of the data for which audit logs are searched. Only audit logs affecting data within this period are returned.

limit System.Nullable<System.Int32>

Limits the number of returned audit log entries to the specified maximum.

cancellationToken System.Threading.CancellationToken

Propagates a notification if the operation should be canceled.

System.Collections.Generic.IAsyncEnumerable<HAKOM.ErrorHandling.Core.Net.Api.Result<IAuditLogEntry>>
An System.Collections.Generic.IAsyncEnumerable<> of IAuditLogEntry containing the filtered audit log entries.

The Result will provide additional information about success or failure.

ITimeSeriesDataStore.TryWrite<TValue>(ITimeSeriesDataWritingOptions, ITimeSeriesDataCollection<TValue>, CancellationToken) Method

Section titled “ITimeSeriesDataStore.TryWrite<TValue>(ITimeSeriesDataWritingOptions, ITimeSeriesDataCollection<TValue>, CancellationToken) Method”

Try to write data to a time series.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result> TryWrite<TValue>(HAKOM.TSM.Net.Api.Data.Persistence.TimeSeries.ITimeSeriesDataWritingOptions timeSeriesDataWritingOptions, HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue> timeSeriesData, System.Threading.CancellationToken cancellationToken)
where TValue : System.IComparable<TValue>, System.IEquatable<TValue>;

TValue

The type of the values of the data points to be written.

timeSeriesDataWritingOptions ITimeSeriesDataWritingOptions

The ITimeSeriesDataWritingOptions.

timeSeriesData HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>

The time series data collection to be written.

cancellationToken System.Threading.CancellationToken

Propagates a notification if the operations should be canceled.

System.Threading.Tasks.Task<Result>
A System.Threading.Tasks.Task<> that completes once all data has been written to the time series and contains a Result with information about success or failure of the operation.

ITimeSeriesDataStore.TryWrite<TValue>(ITimeSeriesDataCollection<TValue>, CancellationToken) Method

Section titled “ITimeSeriesDataStore.TryWrite<TValue>(ITimeSeriesDataCollection<TValue>, CancellationToken) Method”

Try to write data to a time series.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result> TryWrite<TValue>(HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue> timeSeriesData, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IComparable<TValue>, System.IEquatable<TValue>;

TValue

The type of the values of the data points to be written.

timeSeriesData HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>

The time series data collection to be written.

cancellationToken System.Threading.CancellationToken

Propagates a notification if the operations should be canceled.

System.Threading.Tasks.Task<Result>
A System.Threading.Tasks.Task<> that completes once all data has been written to the time series and contains a Result with information about success or failure of the operation.

ITimeSeriesDataStore.Write<TValue>(ITimeSeriesDataWritingOptions, ITimeSeriesDataCollection<TValue>, CancellationToken) Method

Section titled “ITimeSeriesDataStore.Write<TValue>(ITimeSeriesDataWritingOptions, ITimeSeriesDataCollection<TValue>, CancellationToken) Method”

Write data to a time series.

System.Threading.Tasks.Task Write<TValue>(HAKOM.TSM.Net.Api.Data.Persistence.TimeSeries.ITimeSeriesDataWritingOptions timeSeriesDataWritingOptions, HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue> timeSeriesData, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IComparable<TValue>, System.IEquatable<TValue>;

TValue

The type of the values of the data points to be written.

timeSeriesDataWritingOptions ITimeSeriesDataWritingOptions

The ITimeSeriesDataWritingOptions.

timeSeriesData HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>

The time series data collection to be written.

cancellationToken System.Threading.CancellationToken

Propagates a notification if the operations should be canceled.

System.Threading.Tasks.Task
A System.Threading.Tasks.Task that completes once all data has been written to the time series.

ITimeSeriesDataStore.Write<TValue>(ITimeSeriesDataCollection<TValue>, CancellationToken) Method

Section titled “ITimeSeriesDataStore.Write<TValue>(ITimeSeriesDataCollection<TValue>, CancellationToken) Method”

Write data to a time series.

System.Threading.Tasks.Task Write<TValue>(HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue> timeSeriesData, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IComparable<TValue>, System.IEquatable<TValue>;

TValue

The type of the values of the data points to be written.

timeSeriesData HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>

The time series data collection to be written.

cancellationToken System.Threading.CancellationToken

Propagates a notification if the operations should be canceled.

System.Threading.Tasks.Task
A System.Threading.Tasks.Task that completes once all data has been written to the time series.

© 2026 Volue.Version v0.6.38017 November 2026