DKNet.AspCore.Idempotency.MsSqlStore 10.1.17

DKNet.AspCore.Idempotency.MsSqlStore

A SQL Server-backed persistent store for DKNet.AspCore.Idempotency — idempotency keys and cached responses survive application restarts, with a race-free reserve-then-check flow under concurrent duplicate requests.

Features

• Persists idempotency keys and cached responses in SQL Server via EF Core
• Race-free duplicate handling backed by a database unique index, not application-level locking
• Migrations ship with the package and run automatically on first use
• Configured through the same IdempotencyOptions the core package already exposes — no extra options type to learn

Installation

dotnet add package DKNet.AspCore.Idempotency.MsSqlStore

Quick Start

using DKNet.AspCore.Idempotency;
using DKNet.AspCore.Idempotency.MsSqlStore;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddIdempotencyWithMsSqlStore(
    builder.Configuration.GetConnectionString("IdempotencyDb")!,
    options =>
    {
        options.Expiration = TimeSpan.FromHours(48);
        options.ConflictHandling = IdempotentConflictHandling.CachedResult;
    });

var app = builder.Build();

app.MapPost("/orders", () => Results.Ok())
    .RequiredIdempotentKey();

app.Run();

Customisation reference

There is no SQL Server-specific options type. AddIdempotencyWithMsSqlStore configures the shared IdempotencyOptions from DKNet.AspCore.Idempotency:

Values are validated eagerly at registration: an empty header key or cache prefix, a non-positive expiration, a status-code window outside 100–599 or with min above max, a null JsonSerializerOptions, a MaxIdempotencyKeyLength below 1, an empty key pattern, or a whitespace ScopeHmacSecret each throw ArgumentException immediately rather than failing at request time.

Registration entry points

Fixed by this package, not exposed as options

You provide a reachable database and a login that can create tables in it; the package creates and migrates the table on first use. Nothing sweeps expired rows — ExpiresAt is indexed so you can add your own cleanup job.

IdempotencySqlServerStore is internal, so AddIdempotentKey<IdempotencySqlServerStore>() does not compile in application code — AddIdempotencyWithMsSqlStore(...) is the supported way in. Both methods are first-wins: a second call with a different connection string is silently a no-op.

Learn more

Full registration details, the SQL Server schema, and gotchas around migrations and concurrency: DKNet.AspCore.Idempotency.MsSqlStore docs.

Requirements

• .NET 10.0+
• SQL Server 2019+ (or Azure SQL Database)

License

MIT — see LICENSE.

About

Developed by Steven Hoang.