Sieve

⚗️ Sieve is a simple, clean, and extensible framework for .NET Core that adds sorting, filtering, and pagination functionality out of the box. Most common use case would be for serving ASP.NET Core GET queries.

Documentation available on GitHub: https://github.com/Biarity/Sieve/

Initialization

• startup

public void ConfigureServices(IServiceCollection services)
{
    // Add Sieve service
    services.Configure<SieveOptions>(Configuration.GetSection(nameof(SieveOptions)));
    services.AddScoped<ISieveProcessor, K4SieveProcessor>();

    // Register interceptor, must be the last item
    services.AddGrpc(options =>
    {
        // other interceptors
        options.Interceptors.Add<K4GrpcExceptionInterceptor>(); // Exception handling in this order
        options.Interceptors.Add<SieveExceptionInterceptor>(); // Exception handling in this order
    });
}

• appsettings

{
  "SieveOptions": {
    "CaseSensitive": false,
    "DefaultPageSize": 25,
    "MaxPageSize": 100,
    "ThrowExceptions": true,
    "IgnoreNullsOnNotEqual": true
  }
}

• Protobuf definition

message SieveModelRequest {
    google.protobuf.StringValue Filters = 1;
    google.protobuf.StringValue Sorts   = 2;
    google.protobuf.Int32Value Page     = 3;
    google.protobuf.Int32Value PageSize = 4;
}

• Mapping

CreateMap<SieveModelRequest, SieveModel>();

Usage

• Example with count

public async Task<(IEnumerable<queryModel>, int)> GetAll(SieveModel sieveModel)
{
    (var query, var count) = _microserviceContext.Organisations.ApplyAndGetTotalCount(sieveModel, _sieveProcessor);
    return (_mapper.Map<IEnumerable<queryModel>>(await query.ToListAsync()), count);
}

• Example without count

public async Task<IEnumerable<queryModel>> GetAll(SieveModel sieveModel)
{
    var query = _microserviceContext.Organisations.Apply(sieveModel, _sieveProcessor);
    return _mapper.Map<IEnumerable<queryModel>>(await query.ToListAsync());
}

• Example with pagination

public async Task<ListResponse<Organisation>> GetAll(SieveModel sieveModel)
{
    return _microserviceContext.Organisations.ApplyAndGetPaginationAsync(sieveModel, _sieveProcessor, _mapper);
}

Usage from api call

Operators

Notes:

• You can use backslashes to escape special characters and sequences:
  • commas: Title@=some\,title makes a match with "some,title"
  • pipes: Title@=some\|title makes a match with "some|title"
  • null values: Title@=\null will search for items with title equal to "null" (not a missing value, but "null"-string literally)
• You can have spaces anywhere except within {Name} or {Operator} fields