persistence/DD.Persistence.Client/Clients/Interfaces/ITimestampedValuesClient.cs

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

namespace DD.Persistence.Client.Clients.Interfaces;

/// <summary>
/// Клиент для работы с наборами данных, имеющими отметку времени.
/// discriminatorId - идентифицирует конкретный набор данных, прим.: циклы измерения АСИБР, или отчет о DrillTest.
/// discriminatorId формируют клиенты и только им известно что они обозначают.
/// </summary>
public interface ITimestampedValuesClient : IDisposable
{
    /// <summary>
    /// Записать новые данные
    /// Предполагается что данные с одним дискриминатором имеют одинаковую структуру
    /// </summary>
    /// <param name="discriminatorId">Дискриминатор (идентификатор) набора</param>
    /// <param name="dtos"></param>
    /// <param name="token"></param>
    Task<int> AddRange(Guid discriminatorId, IEnumerable<TimestampedValuesDto> dtos, CancellationToken token);

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

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

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

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

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

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

    /// <summary>
    /// Диапазон дат, в пределах которых осуществляется хранение данных
    /// </summary>
    /// <param name="discriminatorId">Дискриминатор (идентификатор) набора</param>
    /// <param name="token"></param>
    Task<DatesRangeDto?> GetDatesRange(Guid discriminatorId, CancellationToken token);

    /// <summary>
    /// 
    /// </summary>
    /// <typeparam name="T"></typeparam>
    /// <param name="idDiscriminator"></param>
    /// <param name="take"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    Task<IEnumerable<T>> GetLast<T>(Guid idDiscriminator, int take, CancellationToken token);
}