persistence/Persistence/Repositories/ITimestampedSetRepository.cs

using Persistence.Models;

namespace Persistence.Repositories;

/// <summary>
/// Репозиторий для хранения разных наборов данных временных рядов.
/// idDiscriminator - идентифицирует конкретный набор данных, прим.: циклы измерения АСИБР, или отчет о DrillTest.
/// idDiscriminator формируют клиенты и только им известно что они обозначают.
/// Так как данные приходят редко, то их прореживания для построения графиков не предусмотрено.
/// </summary>
public interface ITimestampedSetRepository
{
    /// <summary>
    /// Количество записей по указанному набору в БД. Для пагинации.
    /// </summary>
    /// <param name="idDiscriminator"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    Task<int> Count(Guid idDiscriminator, CancellationToken token);

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

    /// <summary>
    /// Получить последние данные
    /// </summary>
    /// <param name="idDiscriminator">Дискриминатор (идентификатор) набора</param>
    /// <param name="props">Фильтр свойств набора. Можно запросить только некоторые свойства из набора</param>
    /// <param name="take"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    Task<IEnumerable<TimestampedSetDto>> GetLast(Guid idDiscriminator, IEnumerable<string>? props, int take, CancellationToken token);

    /// <summary>
    /// Добавление новых данных
    /// </summary>
    /// <param name="idDiscriminator">Дискриминатор (идентификатор) набора</param>
    /// <param name="sets"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    Task<int> InsertRange(Guid idDiscriminator, IEnumerable<TimestampedSetDto> sets, CancellationToken token);
}