Stratara.EventSourcing.EntityFrameworkCore 4.7.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.7.0
                    
NuGet\Install-Package Stratara.EventSourcing.EntityFrameworkCore -Version 4.7.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.7.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.7.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.7.0
                    
#r "nuget: Stratara.EventSourcing.EntityFrameworkCore, 4.7.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.7.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.7.0
                    
Install as a Cake Addin
#tool nuget:?package=Stratara.EventSourcing.EntityFrameworkCore&version=4.7.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, and StrataraIdentityStore — the identity store several hosts share, with its migrations shipped in IdentityStore/Migrations/ (AddStrataraIdentityStore(), MigrateStrataraIdentityStoreAsync()) 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 102 11/6/2026
4.7.1 98 11/5/2026
4.7.0 572 10/30/2026
4.6.1 148 10/29/2026
4.6.0 209 10/28/2026
4.5.0 297 10/28/2026
4.4.10 244 10/26/2026
4.4.9 144 10/26/2026
4.4.8 295 10/24/2026
4.4.7 154 10/23/2026
4.4.6 268 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 421 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

A release for one person who belongs to several tenants — and, sharing one identity store, to several applications.

### Added

- **`MembershipStatus.Former`** records a member who has left. It confers nothing — no role, permission or
 cross-tenant access, never the tenant at sign-in, never a selection — and stays listed until the user's or the
 tenant's erasure removes it.
- **`AddCheckedMembershipTenantClaim<TUser>()`**, a third tenant-claim mode: the claim is stamped at sign-in, kept when
 the security-stamp validator refreshes a cookie sign-in, and checked on every request. A request whose user is no
 longer an active member of the carried tenant loses the claim and resolves to the reserved default tenant, without
 another tenant substituted. Only principals ASP.NET Identity issued are checked; an API key or a token the host
 mints keeps its tenant. The tenant changes only when the host re-issues the sign-in. Combining it with
 `AddMembershipTenantClaimsTransformation()` throws, and a claims transformation of the host's own registered
 beside it is refused at start. Use it where several applications share one identity store:
 `active_tenant` holds one selection per account, so live resolution moves every open session when any of them
 switches.
- **`EventSubject.ForUser(userId)`** and **`EventSubject.NamesAnOwner`**: a stream can be created for a user alone,
 for data that belongs to a person rather than to any of their tenants. It is recorded under the reserved default
 tenant, keeps that owner for every later event whatever tenant the session names, and its encrypted fields — at
 every level — are keyed to the person: shredded by the person's erasure, untouched by any tenant's.
 `KeySubject.User` covers those keys too, so nothing is encrypted for the person again after the erasure.

- **`StrataraIdentityStore`, an identity store several hosts can share on PostgreSQL**, with its migrations shipped
 in `Stratara.EventSourcing.EntityFrameworkCore`. It holds ASP.NET Identity's tables, passkeys included, and the
 tenant directory in the fixed schema `stratara_identity`, with the history in
 `stratara_identity.__stratara_identity_migrations`. `AddStrataraIdentityStore()` registers it on the connection
 string `identitydb` (falling back to `defaultdb`, never through a tenant-routing `IDbResolver`) with the
 directory's stores over it, and refuses a host that turns on `Stores.ProtectPersonalData`;
 `MigrateStrataraIdentityStoreAsync()` creates the database where needed and applies the migrations — hosts that
 migrate at once take turns. The account type is `IdentityUser` and cannot be extended, and the store fixes the
 ASP.NET Identity schema version and key lengths, so every host's model matches the shipped migrations. Within a
 major version the schema changes only additively. Moving an existing identity store onto it means replacing it and
 seeding with the same user and tenant ids; the new guide *Shared Identity Store* describes it.

### Changed

- **Setting a membership to a status other than `Active` clears a selection that pointed at it**, as removing it
 already did.
- **An explicit subject that names a user and no tenant is accepted** by `AppendOnBehalfOfAsync` and
 `CreateOnBehalfOfAsync`; one that names neither is refused as before. A session whose tenant resolved to the
 reserved default still gives an event no owner.
- **BREAKING (behaviour): an event or aggregate type marked `[EncryptData]` as a whole stops the host from starting.**
 `EncryptionMetadataDriftGuard` refuses every registered aggregate, and every event type a registered aggregate
 applies, that carries the attribute on the type; an event type no aggregate applies is refused when it is appended,
 before anything is written. Once its subject was erased such a payload had nothing left to deliver, and a replay or
 rebuild stopped there for good. Mark the properties instead; payloads already written as a whole are still read.
 Commands and other types may still be marked as a whole.

### Fixed

- **A user's erasure shreds their own data through a key store that cannot list its scopes.** The eraser names the
 user's keys under the reserved default tenant itself, at every level; until now only a listing reached the
 user-level one.