Stratara.EventSourcing.EntityFrameworkCore 4.1.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.1.0
                    
NuGet\Install-Package Stratara.EventSourcing.EntityFrameworkCore -Version 4.1.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.1.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.1.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.1.0
                    
#r "nuget: Stratara.EventSourcing.EntityFrameworkCore, 4.1.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.1.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.1.0
                    
Install as a Cake Addin
#tool nuget:?package=Stratara.EventSourcing.EntityFrameworkCore&version=4.1.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. 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 112 9/23/2026
4.2.0 178 9/18/2026
4.1.1 119 9/16/2026
4.1.0 115 9/16/2026
4.0.4 913 9/14/2026
4.0.3 193 9/3/2026
4.0.2 614 9/3/2026
4.0.1 253 9/2/2026
4.0.0 180 8/31/2026
4.0.0-preview.1 77 8/31/2026
3.4.0 160 8/28/2026
3.3.0 136 8/25/2026
3.2.3 145 8/22/2026
3.2.2 140 8/14/2026
3.2.1 142 8/2/2026
3.2.0 160 7/18/2026
3.1.7 443 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

The Orleans execution model ships as two new packages, `Stratara.Orleans` and
`Stratara.Orleans.EntityFrameworkCore`: one writer per aggregate across a cluster, accepted commands that
survive a crash, and projections and sagas that never miss a committed fact. Every host on the Entity
Framework store generates one migration when it upgrades, whether or not it adopts the execution model.
Telemetry type tags now carry the simple type name on every instrument, so a dashboard that filters the
projection, saga or conflict series on the qualified name needs its filter updated. Eight fixes land on
the retry, conflict, redaction and encryption work of 4.0.4, with one new warning to know about.

### Added

- **The Orleans execution model: `Stratara.Orleans` and `Stratara.Orleans.EntityFrameworkCore`.**
 Commands, projections, sagas, durable timers and singleton work run as virtual actors on an Orleans
 10.3 cluster. One aggregate has one writer across the deployment; a command the execution model's
 dispatcher accepts is recorded before the call returns and resumed after a crash, a bounded number of
 times, through the same mediator pipeline as on the bus; projections and sagas read the store in
 commit order from a checkpoint, so a crash costs latency and never a committed fact; singleton work
 runs once per cluster without a lock; a failing entry stops its partition and is retried instead of
 being dropped. Handlers, projections and sagas are unchanged, each role is adopted with one
 registration after its composite, and both models can run side by side during a rollout. Every
 setting is validated at start. See *Choose an Execution Model*, *Migrate to the Orleans Execution
 Model* and *Operate the Orleans Execution Model* on the documentation site.
- **Schema additions — every host on the Entity Framework store generates a migration.** The framework's
 write context declares `event_stream_entry.partition_position`, the `partition_position` table, on
 PostgreSQL `event_stream_entry.commit_transaction_id`, and the `outbox_entry` columns `aggregate_id`,
 `heavy`, `attempt_count`, `last_handed_over_at`, `kept_at` and `last_failure`; the read context declares
 `projection_checkpoint`. They are part of the model whether or not a host adopts the execution model, so
 every host on `Stratara.EventSourcing.EntityFrameworkCore` generates and applies a migration after
 upgrading — without it, appends and outbox writes fail on the missing columns. A store that never runs
 the execution model carries them unfilled; on PostgreSQL an append also reads back the transaction id.
- **Composites without the bus-fed worker.** `AddEventProjectionServices()` and `AddSagaServices()`
 register the projection and saga runtimes without their bus workers; `AddProjectionHandling` and
 `AddSagaHandling` do the same on `IServiceCollection`.
- **Every instrument name is a published constant.** `ApplicationDiagnostics.Metrics` carries a
 `…Name` constant beside each instrument — `EventsAppendedName`, `ProjectionEventsProcessedName`,
 `SagasInFlightName` and the others — so a query or listener references the name instead of a literal.
 `ApplicationDiagnostics.MetricTags.TypeNameValue` gives the value a type tag carries for a type name.
- `LogEvents.Messaging.WorkerQueueDeclaredWithOtherArguments` (`108_112`), the warning a RabbitMQ
 worker logs when it uses an existing queue declared with other arguments.

### Changed

- **`event.type` and `aggregate.type` carry the simple type name on every instrument.** On
 `projection.events.processed`, `saga.events.processed` and `event_source.append.conflicts` the tag
 value changes from the assembly-qualified name (`Shop.Orders.OrderPlaced, Shop.Orders`) to the simple
 name (`OrderPlaced`), the form `event_source.events.appended` already used, so write and read series
 join on the same value. A dashboard or alert that filters those three series on the qualified name
 needs its filter updated; no instrument or tag name changes.
- **`AddAuthorizingCommandOutboxDispatcher()` decorates whichever command dispatcher is registered**, not
 only the RabbitMQ one, and composes with a dispatcher registered after it.

### Fixed

- **RabbitMQ: changing the retry bounds no longer stops a worker from subscribing.** A worker queue
 carries `x-delivery-limit` from the bounds it was first declared with, and RabbitMQ refuses a
 redeclaration with a different value — so a deployment that changed `MessageRetry` failed every
 subscription with `PRECONDITION_FAILED`. An existing queue is now used as it is, and the bus logs
 `108_112` naming it. From RabbitMQ 4.3 the old limit does not cut the new bounds short; before 4.3
 a raised bound needs the drained queue deleted once.
- **Azure Service Bus: a subscription whose `MaxDeliveryCount` is below the bounds no longer hides
 its dead-lettering.** Where the host can read the subscription, the bounds for it are lowered to
 fit under the broker's limit, so the framework makes the move and it reaches `108_110` and
 `messaging.dead_lettered`. The warning `108_111` now says so. A failure to read the subscription
 of any kind other than cancellation ends the check instead of the subscription.
- **A unique violation is a concurrency conflict whatever exception type carries it.** The event
 source consulted the registered `IStoreConflictDetector`s only for an Entity Framework
 `DbUpdateException`, so a unit of work that surfaced the provider's exception unwrapped got a
 persistence failure instead of a `ConcurrencyException`. Every detector now sees the exception
 as the save threw it, as its contract says.
- **Proxy credentials and response cookies are redacted from traces in the form the semantic
 conventions name them.** The HTTP client and ASP.NET Core enrichment callbacks replaced
 `http.request.header.proxy_authorization` and `http.response.header.set_cookie`, but the
 OpenTelemetry semantic conventions keep the dash — `proxy-authorization`, `set-cookie` — so a host
 that captured headers under those names exported the values. Both forms are redacted now.
- **The concurrency-conflict policy retries a conflict the event source reports.** An append that
 lost the race surfaces from `IEventSource.SaveChangesAsync` as `ConcurrencyException`, and
 `ResilienceNames.ConcurrencyConflict` retried only `ConcurrencyConflictException` — so an
 `IResilientRequest` whose handler appends events ran once and failed on the first conflict. The
 policy now retries both, and still nothing else.
- **A revoked encrypted field of a value type reads as its default instead of failing the object.**
 Deserialization wrote an unreadable field back as JSON `null`, which a `decimal`, `int` or other
 non-nullable value type cannot hold — so erasing a subject's key made every record with such a
 field throw instead of degrading. The field now reads as the type's default, and the object's
 other fields are recovered.
- **`InMemoryKeyStore` keeps a scope usable after its current version is revoked.** Revoking the
 current key left the scope pointing at a key that no longer existed, so the next
 `GetOrCreateCurrentKeyAsync` threw. It now falls back to the highest remaining version, or creates
 a new one, as `EnvelopeFileKeyStore` does.
- **`IAggregationService.AggregateAsync` no longer documents `fromVersion` as a start version.** The
 parameter has never been honoured: a rebuild starts from the stream's beginning, or from the latest
 snapshot at or below `toVersion`. Its documentation now says so; the signature is unchanged.