Stratara.EventSourcing.EntityFrameworkCore 4.3.0

Prefix Reserved
dotnet add package Stratara.EventSourcing.EntityFrameworkCore --version 4.3.0
                    
NuGet\Install-Package Stratara.EventSourcing.EntityFrameworkCore -Version 4.3.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.3.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.3.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.3.0
                    
#r "nuget: Stratara.EventSourcing.EntityFrameworkCore, 4.3.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.3.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.3.0
                    
Install as a Cake Addin
#tool nuget:?package=Stratara.EventSourcing.EntityFrameworkCore&version=4.3.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
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.3.0 0 9/23/2026
4.2.0 169 9/18/2026
4.1.1 114 9/16/2026
4.1.0 113 9/16/2026
4.0.4 880 9/14/2026
4.0.3 193 9/3/2026
4.0.2 614 9/3/2026
4.0.1 249 9/2/2026
4.0.0 180 8/31/2026
4.0.0-preview.1 77 8/31/2026
3.4.0 159 8/28/2026
3.3.0 136 8/25/2026
3.2.3 145 8/22/2026
3.2.2 139 8/14/2026
3.2.1 141 8/2/2026
3.2.0 160 7/18/2026
3.1.7 442 7/1/2026
3.1.6 572 6/22/2026
3.1.5 159 6/22/2026
3.1.4 168 6/15/2026
Loading failed

A correctness release for the Orleans execution model's store readers, and the release that makes
Stratara say who acted. The native PostgreSQL commit-order reader could be switched off entirely by a
convention this framework's own API reference recommends — silently, in a deployment that reported
healthy. Beyond that, an actor acting on a tenant it holds no membership in can now hold a role the
host names, and work the platform starts for a tenant has a session shape of its own.

**Upgrading:**
- **If you read the store in commit order on PostgreSQL, upgrade.** A write context that applies
 `ApplyRowVersionConvention(RowVersionMode.Uint)` made every projection catch-up fail with
 `42703: column s.xmin does not exist`, for ever, without the host reporting unhealthy. A consumer
 who worked around it by unmapping `EventStreamEntry.RowVersion` can drop the workaround.
- **Check what your `CrossTenantRoles` names mean on both role levels.** The cross-tenant authorizer
 now also recognises a configured role held through the actor's own membership, so it permits
 operations it refused before.
- **A host whose handlers append events needs `AddCommandAuditing()`.** It always did; now it is
 refused before the commit instead of failing in the database.
- No schema change, no migration.

### Added

- **`SessionContext.ForPlatform(tenantId)`**: the session for work the platform starts on a tenant's
 behalf — a durable timer, a saga step, a sweep. It carries the reserved system actor identities, a
 fresh correlation id and a causation id of its own, so the work can append without a command having
 preceded it. Strict tenant isolation recognises the shape and permits it without consulting the
 cross-tenant authorizer, recorded under its own log event (`114_104`): the platform acting *for* a
 tenant is not one tenant acting *on* another. The data-owner check applies unchanged. A host that
 wants to decide for itself sets `TenantIsolationOptions.AuthorizePlatformActor`. Until now the
 sentinels existed, the documentation named them, and nothing in the framework acted on them — the
 honest session was refused by strict mode, and the session that passed claimed the tenant had acted.
- **`MembershipAuthorizationOptions.HomeTenantRoles`**: roles that resolve in the tenant the actor is a
 member of rather than in the tenant the request concerns. For an actor acting on a tenant it holds no
 membership in and never can: a machine key, which materialises one membership in the tenant it was
 issued for and serves many, or an operator administering a tenant they never joined — both were
 refused every role check. Configure it with `AddMembershipAuthorization(o => o.HomeTenantRoles.Add("Service"))`.
 Empty by default, consulted only when the actor's tenant differs from the data owner's, and only the
 named roles cross.

### Fixed

- **The native PostgreSQL commit-order reader reads a store under any column mapping.** It selected the
 event table with a wildcard, which returns no system column. A write context that applies the
 framework's own row-version convention maps the entry's row version onto PostgreSQL's `xmin`, so every
 catch-up of every projection grain failed with `42703: column s.xmin does not exist` and retried for
 ever — no checkpoint written, nothing dead-lettered, the host reporting healthy and every write
 succeeding. The reader now names the columns the model maps. A consumer who worked around this by
 unmapping `EventStreamEntry.RowVersion` can drop the workaround.
- **Entries committed together reach a store-reading projection in stream order.** The native reader
 returned the entries of one commit in the order the database inserted the rows, which is not the order
 they were appended in: a stream created and appended to in one save could hand a projection version 2
 before version 1, and no retry could help, because the beginning was behind it in the same partition
 rather than late. Each stream's entries are now returned in version order, which is what the portable
 counter already did. Entries of different streams in one commit may still be interleaved in any order.

### Changed

- **The cross-tenant authorizer now recognises a configured platform role held through the actor's own
 membership.** `MembershipCrossTenantAuthorizerOptions.CrossTenantRoles` is documented as the path for
 an operator who holds no membership in the tenant they administer, but the role was looked up through
 a role check that reads the subject tenant — the very tenant the option says the actor is not a member
 of. On the membership level it could therefore never pass, and a machine actor has no global role
 level at all, so for a machine actor the option did nothing. The actor's own membership is now
 consulted as well.
 **This permits cross-tenant operations that were refused before.** Before upgrading, check what the
 names in your `CrossTenantRoles` mean on both role levels: a host that configured `"Admin"` intending
 the global Identity role now also admits an actor holding a tenant-scoped membership role of the same
 name in its own tenant. `"Admin"`, `"Owner"` and `"TenantAdmin"` collide between the two levels
 routinely. The widening is in the direction the requirement has always stated, and it reaches only
 actors holding a role the host itself named.

- **Appending without a causation identity is refused before the commit.** The session context carries a
 nullable causation id, but the store requires one of every entry, and only `AddCommandAuditing()`
 supplies it. A host that had not registered it met a `23502` not-null violation from the database that
 read like a schema fault. `SaveChangesAsync` now refuses the append before the transaction opens, with a
 message naming the registration. `AddCommandServices()` still does not register the auditing behaviours
 — where they sit in the pipeline is a consumer's decision.