ChunkingRedisClient 2.0.1

.NET Standard 2.0
NuGet\Install-Package ChunkingRedisClient -Version 2.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
dotnet add package ChunkingRedisClient --version 2.0.1
<PackageReference Include="ChunkingRedisClient" Version="2.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ChunkingRedisClient --version 2.0.1
#r "nuget: ChunkingRedisClient, 2.0.1"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install ChunkingRedisClient as a Cake Addin
#addin nuget:?package=ChunkingRedisClient&version=2.0.1

// Install ChunkingRedisClient as a Cake Tool
#tool nuget:?package=ChunkingRedisClient&version=2.0.1

Chunking Redis Client

A C#/.NET Core library which wraps the StackExchange.Redis client, specifically using JSON serialisation, and adds functionality such as chunked reading/writing and sliding expiration.

To install without the source, use the NuGet package: https://www.nuget.org/packages/ChunkingRedisClient/

The purpose of this library is to create a re-usable library of code for wrapping the StackExchange.RedisClient and solving the issues I usually need to solve.

Those being:

  • IoC wrappers/abstractions<br/>

    • Just take your dependency on IRedisClient<TKey, TItem><br/>
    • By default you should configure your DI container to inject the provided RedisClient<TKey, TItem><br/>
    • Since IoC is used throughout you also need to configure:<br/> ~ IRedisWriter<TKey, Item> → JsonRedisWriter or ChunkedJsonRedisWriter<br/> ~ IRedisReader<TKey, Item> → JsonRedisReader or ChunkedJsonRedisReader<br/> ~ IRedisWriter<TKey, Item> → JsonRedisDeleter or ChunkedJsonRedisDeleter<br/> (note: for one combination of TKey, TItem - ensure the decision to chunk or not is consistent)<br/> ~ IKeygen<TKey> to an object specific implementation, like GuidKeygen<br/> ~ For chunking, locking is required:<br/> IRedisLockFactory → RedisLockFactory<br/> To override the default of InMemoryRedisLock, call RedisLockFactory.Use<IRedisLock>() <-- your class here<br/>
  • Strongly typed access to the cache<br/>

    • Use any C# object as your TKey and TItem, given that:<br/> ~ You can implement your own Keygen for TKey<br/> ~ Your TItem is serialisable by Newtonsoft.Json<br/>
  • Implementing the StackExchange Connection Multiplexer<br/>

    • This is handled by the RedisDatabaseFactory<br/>
    • Not using the usual Lazy<ConnectionMulitplexer> approach, as I want to support one multiplexer per connection string (if your app is dealing with more than 1 cache)<br/>
    • The multiplexers are stored in a concurrent dictionary where the connection string is the key<br/>
    • The multiplexer begins connecting asynchronously on first use<br/>
  • Sliding expiration of cache keys<br/>

    • Pass in the optional timespan to read methods if you want to use sliding expiration<br/>
    • This updates the expiry when you read the item, so that keys which are still in use for read purposes live longer<br/>
  • Chunked JSON data<br/>

    • This solves a performance issue whereby Redis does not perform well with large payloads.<br/>
    • Sometimes you may also have had errors from the server when the queue is full.<br/>
    • The default chunk size is 10KB which can be configured in the ChunkedJsonRedisWriter<br/>
    • The JSON data is streamed from Newtonsoft into a buffer. Every time the buffer is full it is written to Redis under the main cache key with a suffix of "chunkIndex"<br/>
    • The main cache key is then written to contain the count of chunks, which is used by the reader and deleter.<br/>
  • Generating keys for objects<br/>

    • I don't like using bytes for keys as they are not human readable, so I like to generate unique strings<br/>
    • There is no none-intrusive way of providing a type agnostic generic keygen, therefore you must write your own. If you write something for a CLR type, considering contributing it to the project!
    • Since we know Guids are unique, I have demonstrated the ability to create custom keygens.<br/>

The code can be extended to support other serialisation types (TODO), distributed locks (TODO), different ways of generating keys or whatever you need it to do.

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.1 89 6/23/2022
1.0.2 581 3/5/2019
1.0.1 520 1/28/2019
1.0.0 593 1/8/2019