PersistedCache 0.0.1

Persisted Cache

Persisted Cache is a simple caching library that allows you to turn any stateful resource into a key-value store. It is designed to be simple and easy to use, meanwhile it spare you the hassle and costs of managing a separate cache server.

Why would you use this?

• Your team doesn't want to manage a separate cache server.
• You need a distributed cache that can be shared across multiple instances of your application.
• You need a cache that can be persisted to disk.
• You need a cache that can be shared across multiple applications.

How to use it?

Install the specific package for the resource you want to use. For example, if you want to use MySQL as the cache store, you would install the PersistedCache.MySql package.

dotnet add package PersistedCache.MySql

Or simply add it from the NuGet package gallery.

Currently supported and planned resources are:

• MySQL - PersistedCache.MySql
• PostgreSQL
• SQLite
• MongoDB
• SQL Server
• File System
• AWS S3 (maybe)
• Azure Blob Storage (maybe)

Add the service to your DI container

services.AddMySqlPersistedCache("Your connection string here", options =>
{
    // The name of the table to use for the cache
    options.TableName = "persisted_cache";
    
    // Can be set to false after the table is created (or if you want to manage the table yourself)
    options.CreateTableIfNotExists = true; 
    
    // Purges expired entries based on configured expiry interval
    options.PurgeExpiredEntries = true;
    
    // The interval at which the cache purges expired entries
    options.PurgeInterval = TimeSpan.FromHours(24);
    
    // If you need to serialize/deserialize objects differently
    options.JsonOptions = new JsonSerializerOptions()
});

All the options shown above are optional and have default values, only the connection string is required.

Use the cache

public class MyService
{
    private readonly IPersistedCache _cache;

    public MyService(IPersistedCache cache)
    {
        _cache = cache;
    }
    
    public void SetSomething()
    {
        _cache.Set("my-key", "some value", Expire.InMinutes(5));
    }

    public string GetSomething()
    {
        return _cache.Get<string>("my-key");
    }
}

Methods

Want to contribute?

If you want to contribute to this project, please feel free to open an issue or a pull request.