LiteDbContext 1.0.0-rc.8

<h1 align="center">LiteDbContext</h1>

<div align="center">

A light-weight async wrapper around LiteDB

</div>

Key Features:

• Modern C#
• Supports cancellations

Usage

1. Define a LiteDbContext:

using LiteDB;

// ...

public sealed class ExampleDbContext(LiteDbOptions options) : LiteDbContext(options)
{
    // NOTE: if a `name` is not provided to `DbSet<T>(string? name)`, `[CallerMemberName]` will provide the `PropertyInfo.Name` for you, e.g. `Examples`
    public LiteDbSet<ExampleEntity> Examples => DbSet<ExampleEntity>();
}

public sealed record class ExampleEntity
{
    public required string Key { get; init; }
    public string Value { get; init; }
}

2. Add your LiteDbContext as a service:

using LiteDB.Extensions.DependencyInjection;

// ...

IServiceCollection services;

 // ...

services.AddLiteDbContext<ExampleDbContext>(options =>
{
    options.ConnectionString = "...";

    options.Mapper.ConfigureExamples();
});

// ...

internal static class ExampleEntityConfiguration
{
    public static BsonMapper ConfigureExamples(this BsonMapper mapper)
    {
        mapper.Entity<ExampleEntity>()
            .Id(example => example.Key);

        return mapper;
    }
}

3. Use you LiteDbContext:

public sealed class ExampleController
{
    [HttpGet]
    public async Task<ActionResult<ExampleEntity[]>> Index(
        [FromServices] ExampleDbContext context,
        [FromQuery, Required] string query)
    {
        var examples = await context.Examples.Query()
            .Where(example => example.Value.StartsWith( query ))
            .ToArrayAsync(HttpContext.RequestAborted);

        return Ok(examples);
    }
}

How'd He Do It?

Work against the database is synchronized via a queue, backed by an unbounded Channel.

See DbWorkQueue.