Carried.Idempotency.EntityFrameworkCore 1.2.0

Carried.Idempotency

A lightweight, storage-agnostic idempotency engine for .NET with ASP.NET Core integration and distributed storage providers.

Packages

📥 Installation

ASP.NET Core

dotnet add package Carried.Idempotency.AspNet

Redis

dotnet add package Carried.Idempotency.Redis

Entity Framework Core

dotnet add package Carried.Idempotency.EntityFrameworkCore

Core

For use without ASP.NET Core:

dotnet add package Carried.Idempotency

Carried.Idempotency.DependencyInjection is normally installed transitively and does not need to be installed directly.

🚀 Getting Started

ASP.NET Core

Register idempotency:

builder.Services.AddIdempotency(options =>
{
    options.UseInMemory();
});

Add the middleware:

app.UseIdempotency();

Enable idempotency on an endpoint:

app.MapPost("/orders", async () =>
{
    // Create order...
})
.RequireIdempotency();

Clients provide an idempotency key with the request:

Idempotency-Key: request-123

Controllers can use the RequireIdempotency attribute instead:

[RequireIdempotency]
[HttpPost]
public async Task<IActionResult> AddOrder()
{
    // Create order...
}

Redis

For distributed applications, register an IConnectionMultiplexer:

builder.Services.AddSingleton<IConnectionMultiplexer>(_ =>
    ConnectionMultiplexer.Connect(
        builder.Configuration.GetConnectionString("Redis")!));

Then select Redis as the provider:

builder.Services.AddIdempotency(options =>
{
    options.UseRedis();
});

The application owns the IConnectionMultiplexer and its lifetime.

Entity Framework Core

Register your DbContext and select the Entity Framework Core provider:

builder.Services.AddDbContext<AppDbContext>(options =>
{
    // Configure your database provider.
});

builder.Services.AddIdempotency(options =>
{
    options.UseDbContext<AppDbContext>();
});

Add the idempotency model configuration to your DbContext:

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    base.OnModelCreating(modelBuilder);

    modelBuilder.AddIdempotency();
}

The idempotency table is managed through your application's normal Entity Framework Core migrations.

Core

The Core engine can be used independently of ASP.NET Core:

var idempotency = IdempotencyService.CreateInMemory();

var key = new IdempotencyKey(
    scope: "orders-create",
    value: "request-123");

var result = await idempotency.ExecuteAsync(
    key,
    fingerprint: "my-fingerprint-here",
    async cancellationToken =>
    {
        // Perform operation.

        return IdempotencyOperationResult<string>.Complete("result");
    },
    cancellationToken);

💾 Storage Providers

The in-memory provider is intended for single-process use. Redis and Entity Framework Core support coordination across application instances using shared storage.

Custom providers can be implemented using IIdempotencyStore.

📚 Documentation

See the project documentation for guides, configuration, and API reference.

Carried.Idempotency Documentation

🧪 Example

An example ASP.NET Core application is available at:

examples/Carried.Idempotency.ExampleApi

📋 License

Carried.Idempotency is licensed under the MIT License.

See LICENSE for details.