CachedQueries 1.0.17

CachedQueries

A library provides IQueryable results caching with smart invalidation.

The main goal is to bring caching to ef queries with flexible invalidation without any abstraction over DbSet.

For example:

    await context.Customers
        .Query(request)
        .ToCachedListAsync(cancellationToken);
        
    await context.Customers
        .FindById(id)
        .CachedFirstOrDefaultAsync(cancellationToken);

Query and FindById extensions could contain filters, include related entities, etc. Using these queries in different places still returns cached results until the Customer entity will be modified.

Setup

Setup with DI

// services is IServicesCollection
services.AddQueriesCaching(options =>
    options.UseEntityFramework());

...
// app is IApplicationBuilder
app.UseQueriesCaching();

Options also allows to define own implementations of cache key factory, lock manager, cache options, cache invalidator.

Usage

Cache collection

var results = context.Blogs
    .Include(x => x.Posts)
    .ToCachedListAsync(cancellationToken);

// with expiration
var results = context.Posts
    .ToCachedListAsync(Timespan.FromHours(8), cancellationToken);
    
// with custom tags
var results = context.Posts
    .ToCachedListAsync(Timespan.FromHours(8), new List<string> { "all" }, cancellationToken);

Cache item

var result = context.Blogs
    .Include(x => x.Posts)
    .CachedFirstOrDefaultAsync(x => x.Id == request.Id, cancellationToken);

// with expiration
var result = context.Posts
    .CachedFirstOrDefaultAsync(Timespan.FromHours(8), cancellationToken);
    
// with custom tags
var result = context.Posts
    .CachedFirstOrDefaultAsync(Timespan.FromHours(8), new List<string> { "all" }, cancellationToken);

Invalidate cache

By default, all invalidation tags are retrieved from Include and ThenInclude as navigation properties type names. To invalidate the cache just call this extension before context save changes.

await context.ChangeTracker.ExpireEntitiesCacheAsync();

For more details pls take a look on the tests =)