Proxfield.Extensions.Caching.SQLite.DependencyInjection 2.0.0

<p align="center"> <img src="https://github.com/proxfield/Proxfield.Extensions.Caching.SQLite/assets/7343019/967483a9-c62e-4730-99a3-5f1b1aa0e358" alt="Proxfield.Extensions.Caching.SQLite Logo" /> </p>

Proxfield.Extensions.Caching.SQLite

The SQLite Caching Library is a layer for caching data on SQLite to be used as a secondary database in case of failures and network inconsistencies.

This library is based on Microsoft.Extensions.Caching.StackExchangeRedis for memory caching, but uses SQLite as the data store. It serves as a persistent cache layer, leveraging Microsoft.Data.Sqlite.

Packages

Packages and versions available at the Nuget Gallery.

Package	Version	Downloads
Proxfield.Extensions.Caching.SQLite
Proxfield.Extensions.Caching.SQLite.DependencyInjection

Installation

PM> Install-Package Proxfield.Extensions.Caching.SQLite

For applications using Microsoft.Extensions.DependencyInjection, use the DI package:

PM> Install-Package Proxfield.Extensions.Caching.SQLite.DependencyInjection

Visit the Nuget Repository Page to learn more.

Usage

Initialization can be done via standard instantiation or through Dependency Injection.

Common Initialization

var cache = new SQLiteCache(options =>
{
    options.Location = @"c:\cache\database.sqlite";
});

Dependency Injection Initialization

services.AddSQLiteCache(options => {
    options.Location = @"c:\cache\database.sqlite";
});

Configuration

Database File Location

If options.Location is not provided, the database will be stored in the same folder as the running application.

Encryption

To enable data encryption, set UseEncryption to true and provide an EncryptionKey:

services.AddSQLiteCache(options => {
    options.UseEncryption = true;
    options.EncryptionKey = "d5644e8105ad77c3c3324ba693e83d8f";
});

Caching Methods

Data can be stored/retrieved as simple strings or complex objects.

Basic Usage

// Store as string
this.cache.SetAsString("users/1", "jose");
var userName = this.cache.GetAsString("users/1");

// Store as object
this.cache.SetAsObject<User>("users/1", new User() { Name = "Jose" });
var user = this.cache.GetAsObject<User>("users/1");

Available Methods

Collections and Indexes

You can index cached objects/strings. For example, saving an object with key vehicles/1:

cache.SetAsObject("vehicles/1", new { Name = "bicycle" });

This makes it possible to query multiple objects at once (e.g., every document in a collection):

cache.GetAsObjectStartsWith<Vehicle>("vehicles");

Index Management Methods

Accessed via cache.Maintenance.

Platform Support

SQLite Caching is compiled for:

• .NET 6
• .NET 5
• .NET Core 3.1

License

The MIT License (MIT) - Copyright (c) 2022-2026 Proxfield Consulting Group and its affiliates.