Stratara.EventSourcing.EntityFrameworkCore 4.6.0

Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package Stratara.EventSourcing.EntityFrameworkCore --version 4.6.0
                    
NuGet\Install-Package Stratara.EventSourcing.EntityFrameworkCore -Version 4.6.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Stratara.EventSourcing.EntityFrameworkCore" Version="4.6.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Stratara.EventSourcing.EntityFrameworkCore" Version="4.6.0" />
                    
Directory.Packages.props
<PackageReference Include="Stratara.EventSourcing.EntityFrameworkCore" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Stratara.EventSourcing.EntityFrameworkCore --version 4.6.0
                    
#r "nuget: Stratara.EventSourcing.EntityFrameworkCore, 4.6.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Stratara.EventSourcing.EntityFrameworkCore@4.6.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Stratara.EventSourcing.EntityFrameworkCore&version=4.6.0
                    
Install as a Cake Addin
#tool nuget:?package=Stratara.EventSourcing.EntityFrameworkCore&version=4.6.0
                    
Install as a Cake Tool

Stratara.EventSourcing.EntityFrameworkCore

Derived. The behaviour described here is specified under openspec/specs/. Those specifications are the source; this page explains and illustrates them.

License: MIT.

EF Core persistence for the Stratara event-sourced stack — PostgreSQL flavoured via Npgsql. pgvector types are mapped for a model that has vector columns; a model without them runs on a plain PostgreSQL server, no vector extension needed. Bundles four previously-separate Stratara projects into one NuGet because they always ship together:

Folder Contents Old csproj
EntityFrameworkCore/ shared EF conventions, value generators, IDbContext / IReadDbContext / IWriteDbContext / ITenantScopedDbContext / IIdentityDbContext, UnitOfWork base, DefaultDbResolver, NpgsqlDbContextServiceCollectionExtensions, DbContextMigrationUtility Stratara.EntityFrameworkCore
WriteStore/ WriteDbContext, WriteUnitOfWork, event-stream/snapshot/event-chain/command-audit/outbox repositories + entity configurations Stratara.EventSourcing.EntityFrameworkCore.WriteStore
ReadStore/ ReadDbContext, ReadUnitOfWork, ProjectionsUnitOfWork, Tenant repository, projection entity configurations Stratara.EventSourcing.EntityFrameworkCore.ReadStore
ReadStore/Replay/ AddReadModelRestore<TReadContext>(): keeps the read models a replay empties and writes them back when it fails; ReadModelRestoreOptions (section ProjectionReplay:Restore) Stratara.EventSourcing.EntityFrameworkCore.ReadStore.Replay
IdentityStore/ Generic ASP.NET Identity IdentityDbContext + marker Stratara.EventSourcing.EntityFrameworkCore.IdentityStore

Everything lives under Stratara.EventSourcing.EntityFrameworkCore and its sub-namespaces (.WriteStore, .ReadStore, .IdentityStore, .Abstractions, .Conventions, .Extensions, .HealthChecks, .Migration). The DI extensions sit in Microsoft.Extensions.DependencyInjection, per the Microsoft convention, so they resolve without an extra using.

Why folded

WriteStore-without-ReadStore is not a real use case. EF conventions + value generators + UnitOfWork primitives are foundational for every other store. ASP.NET Identity glue follows the same EF Core conventions. Splitting into 4 NuGets that always ship together adds version-management noise (4× <PackageVersion> to keep in sync, transitive-resolution risk) without any consumer benefit.

If your application doesn't use ASP.NET Identity, simply don't reference IdentityDbContext-derived types — the rest of the package works without them.

Quick start

Derive your contexts from the generic base classes — the type argument is the context itself:

using Stratara.EventSourcing.EntityFrameworkCore.WriteStore;
using Stratara.EventSourcing.EntityFrameworkCore.ReadStore;

public sealed class MyAppWriteDbContext(DbContextOptions<MyAppWriteDbContext> options)
    : WriteDbContext<MyAppWriteDbContext>(options);

public sealed class MyAppReadDbContext(DbContextOptions<MyAppReadDbContext> options)
    : ReadDbContext<MyAppReadDbContext>(options);

Then register the Npgsql context factories and the write store. Each factory registration also registers the unit of work over its context — IWriteUnitOfWork for the write side, IProjectionsUnitOfWork / IReadUnitOfWork for the read side — unless the host registered its own. The write-side unit of work also draws on ISessionContextProvider and ISecureJsonSerializer, which AddSessionContext() and AddSecurity() provide (every worker composite applies both); with those in place, this is all the store needs from the host:

// In your AppHost / Worker / Web project:
builder.Services
    .AddNpgsqlWriteDbContextFactory<MyAppWriteDbContext>()
    .AddNpgsqlReadDbContextFactory<MyAppReadDbContext>()
    .AddWriteStore(builder.Configuration);                    // binds Stratara:EventSourcing options

Most hosts don't call these directly — the worker composites in Stratara.EventSourcing.WorkerDefaults (AddCommandWorkerServices(), AddEventProjectionWorkerServices(), …) already compose AddWriteStore for you. Reach for the explicit form when you build a host that none of the composites fit.

Renamed in 3.2.0, removed in 4.0.0: the write-side factory was AddNpsqlWriteDbContextFactory (missing the g) through 3.1.x. AddNpgsqlWriteDbContextFactory replaced it in 3.2.0 and the old spelling stayed as an [Obsolete] alias until 4.0.0, which removed it. A host still on the old spelling adds the g; nothing else about the call changes.

Health checks

Two opt-in readiness checks plug into any IHealthChecksBuilder (they require the write store above to be registered):

builder.Services.AddHealthChecks()
    .AddEventStoreHealthCheck()                                  // write-side DB reachable?
    .AddOutboxHealthCheck(degradedThreshold: 1_000,             // outbox backlog depth
                          unhealthyThreshold: 10_000);
  • AddEventStoreHealthCheck() — probes write-store connectivity; Unhealthy when the database cannot be reached.
  • AddOutboxHealthCheck(degradedThreshold?, unhealthyThreshold?) — reports the pending outbox backlog under the pending data key and escalates to Degraded / Unhealthy when the count crosses the supplied thresholds (omit them to stay healthy while reachable).

Both are tagged ready by default, so they show up on a readiness endpoint rather than the liveness (live) one.

Dependencies

  • Stratara.Projections — for projection types used by ProjectionsUnitOfWork.
  • Stratara.Shared — for diagnostics + abstractions + resilience.
  • Npgsql.EntityFrameworkCore.PostgreSQL, EFCore.NamingConventions, Microsoft.AspNetCore.Identity.EntityFrameworkCore, Microsoft.EntityFrameworkCore, Microsoft.Extensions.Diagnostics.HealthChecks, Pgvector.EntityFrameworkCore.
Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (4)

Showing the top 4 NuGet packages that depend on Stratara.EventSourcing.EntityFrameworkCore:

Package Downloads
Stratara.Infrastructure

Infrastructure glue for the Stratara framework — authorization decorators, configuration providers, and DI composition helpers that wire Mediator, Outbox, Identity, and EF Core into a hosted app.

Stratara.EventSourcing.WorkerDefaults

Worker-host wiring composites for the Stratara event-sourced stack. IHostApplicationBuilder extensions (AddBackendServices, AddCommandWorkerServices, AddHeavyCommandWorkerServices, AddEventProjectionWorkerServices, AddEventStreamHashWorkerServices, AddSagaWorkerServices, AddOutboxWorkerServices, and AddCommandServices, AddEventProjectionServices and AddSagaServices without the bus-fed workers) bundle the per-concern DI calls so each worker host opts in with one line.

Stratara.Testing.EntityFrameworkCore

Spin up the real Stratara event-sourcing write stack (EventSource, aggregation, snapshots, the EF Core write store) against a shared in-memory SQLite database in one call — production code paths, no Postgres, no Docker. Builds on Stratara.Testing's in-memory doubles.

Stratara.Orleans.EntityFrameworkCore

Entity Framework Core persistence for the Stratara Orleans execution model — the commit-order readers (native PostgreSQL and a portable per-partition counter), the projection checkpoint store and the store-schema additions they need.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
4.8.0 0 11/6/2026
4.7.1 77 11/5/2026
4.7.0 571 10/30/2026
4.6.1 147 10/29/2026
4.6.0 208 10/28/2026
4.5.0 296 10/28/2026
4.4.10 243 10/26/2026
4.4.9 143 10/26/2026
4.4.8 295 10/24/2026
4.4.7 154 10/23/2026
4.4.6 267 10/22/2026
4.4.5 334 10/14/2026
4.4.4 333 10/10/2026
4.4.3 169 10/10/2026
4.4.2 439 10/2/2026
4.4.1 420 9/29/2026
4.4.0 181 9/27/2026
4.3.1 181 9/25/2026
4.3.0 343 9/23/2026
4.2.0 215 9/18/2026
Loading failed

An erasure shreds every key that names the subject, and nothing stopped the next encryption for that subject
from creating a new one: a key store asked for a scope it does not hold creates a first version. A job, a request
in flight or a second process that encrypted for an erased subject afterwards got a fresh key, and what it wrote
stayed readable for good. The key store now records an erased subject and refuses to create a key for it again.

### Added

- **`IKeyStore.MarkSubjectErasedAsync(KeySubject)`** records that a tenant or user has been erased. It has a
 default implementation that throws `NotSupportedException`, so an existing key store still compiles.
- **`KeySubject`** names the tenant or user, and `KeySubject.Covers(KeyScope)` states which keys belong to its
 erasure: for a tenant, a key of any level that names it; for a user, a user-level key that names it.
- **`KeyScopeErasedException`** (an `InvalidOperationException`) is what a key store throws for such a scope. It
 carries the refused `Scope`.

### Changed

- **An encryption for an erased subject fails.** After a subject's erasure, `GetOrCreateCurrentKeyAsync` and
 `RotateAsync` throw `KeyScopeErasedException` for every scope the subject covers, whether or not it ever held a
 key, and create nothing. The blob encryptor, the encrypting settings store and the field-encrypting serializer
 pass it through. Code that erased a subject and then wrote encrypted data for it again now sees the exception;
 the mark is permanent and cannot be lifted. Revoking every version of a scope is not an erasure and marks nothing.
- **`ISubjectEraser` marks the subject before it sweeps any plane**, so an encryption racing the erasure
 either creates its key first, and that key is shredded with the rest, or is refused. A key store that cannot mark
 a subject leaves the erasure as before and logs `SubjectNotMarkable` (112009).
- **The file-backed key store writes format version 2**, which holds the marks, and refuses to open a file in a
 newer format than it knows. `InMemoryKeyStore` refuses an erased subject as the file store does; `DummyKeyStore`
 refuses to mark one, as it refuses every erasure operation.

**Upgrading:**
- **Upgrade every process that shares a key store file in one step.** A process on an earlier release reads a
 version-2 file, ignores the marks, creates keys for an erased subject and drops the marks the next time it writes
 the file. A version-1 file needs no migration. Rolling back is possible but loses the marks on the first write.
- **Map `KeyScopeErasedException` to your answer for data that is gone**, if a request can reach an encryption for
 a subject after its erasure.
- **A key store of your own implements `MarkSubjectErasedAsync`**, refusing in `GetOrCreateCurrentKeyAsync` and
 `RotateAsync` every scope a marked subject `Covers`. Without it the erasure warns and the gap stays open.