persistence/DD.Persistence/Services/Interfaces/ITimestampedValuesService.cs

using DD.Persistence.Models;
using DD.Persistence.Models.Common;

namespace DD.Persistence.Services.Interfaces;

/// <summary>
/// Сервис для работы с временными данными
/// </summary>
public interface ITimestampedValuesService
{
    /// <summary>
    /// Добавление записей
    /// </summary>
    /// <param name="discriminatorId"></param>
    /// <param name="dtos"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    Task<int> AddRange(Guid discriminatorId, IEnumerable<TimestampedValuesDto> dtos, CancellationToken token);

    /// <summary>
    /// Количество записей по указанному набору в БД. Для пагинации
    /// </summary>
    /// <param name="discriminatorId">Дискриминатор (идентификатор) набора</param>
    /// <param name="token"></param>
    /// <returns></returns>
    Task<int> Count(Guid discriminatorId, CancellationToken token);

    /// <summary>
    /// Получение данных с фильтрацией. Значение фильтра null - отключен
    /// </summary>
    /// <param name="discriminatorId">Дискриминатор (идентификатор) набора</param>
    /// <param name="geTimestamp">Фильтр позднее даты</param>
    /// <param name="columnNames">Фильтр свойств набора. Можно запросить только некоторые свойства из набора</param>
    /// <param name="skip"></param>
    /// <param name="take"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    Task<IEnumerable<TimestampedValuesDto>> Get(Guid discriminatorId, DateTimeOffset? geTimestamp, IEnumerable<string>? columnNames, int skip, int take, CancellationToken token);

    /// <summary>
    /// Получение данных с начала
    /// </summary>
    /// <param name="discriminatorId">Дискриминатор (идентификатор) набора</param>
    /// <param name="takeCount">Количество</param>
    /// <param name="token"></param>
    /// <returns></returns>
    Task<IEnumerable<TimestampedValuesDto>> GetFirst(Guid discriminatorId, int takeCount, CancellationToken token);

    /// <summary>
    /// Получить данные, начиная с определенной даты
    /// </summary>
    /// <param name="discriminatorId"></param>
    /// <param name="timestampBegin">дата начала</param>
    /// <param name="token"></param>    
    /// <returns></returns>
    Task<IEnumerable<TimestampedValuesDto>> GetGtDate(Guid discriminatorId, DateTimeOffset timestampBegin, CancellationToken token);

    /// <summary>
    /// Получение данных с конца
    /// </summary>
    /// <param name="discriminatorId">Дискриминатор (идентификатор) набора</param>
    /// <param name="takeCount">Количество</param>
    /// <param name="token"></param>
    /// <returns></returns>
    Task<IEnumerable<TimestampedValuesDto>> GetLast(Guid discriminatorId, int takeCount, CancellationToken token);

    /// <summary>
    /// Получить список объектов с прореживанием
    /// </summary>
    /// <param name="discriminatorId"></param>
    /// <param name="timestampBegin">дата начала</param>
    /// <param name="intervalSec"></param>
    /// <param name="approxPointsCount"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    Task<IEnumerable<TimestampedValuesDto>> GetResampledData(Guid discriminatorId, DateTimeOffset timestampBegin, double intervalSec = 600, int approxPointsCount = 1024, CancellationToken token = default);

    /// <summary>
    /// Получить диапазон дат, для которых есть данные
    /// </summary>
    /// <param name="discriminatorId"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    Task<DatesRangeDto?> GetDatesRange(Guid discriminatorId, CancellationToken token);
}