Stratara.EventSourcing.EntityFrameworkCore
4.4.3
Prefix Reserved
See the version list below for details.
dotnet add package Stratara.EventSourcing.EntityFrameworkCore --version 4.4.3
NuGet\Install-Package Stratara.EventSourcing.EntityFrameworkCore -Version 4.4.3
<PackageReference Include="Stratara.EventSourcing.EntityFrameworkCore" Version="4.4.3" />
<PackageVersion Include="Stratara.EventSourcing.EntityFrameworkCore" Version="4.4.3" />
<PackageReference Include="Stratara.EventSourcing.EntityFrameworkCore" />
paket add Stratara.EventSourcing.EntityFrameworkCore --version 4.4.3
#r "nuget: Stratara.EventSourcing.EntityFrameworkCore, 4.4.3"
#:package Stratara.EventSourcing.EntityFrameworkCore@4.4.3
#addin nuget:?package=Stratara.EventSourcing.EntityFrameworkCore&version=4.4.3
#tool nuget:?package=Stratara.EventSourcing.EntityFrameworkCore&version=4.4.3
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 theg) through 3.1.x.AddNpgsqlWriteDbContextFactoryreplaced 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 theg; 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;Unhealthywhen the database cannot be reached.AddOutboxHealthCheck(degradedThreshold?, unhealthyThreshold?)— reports the pending outbox backlog under thependingdata key and escalates toDegraded/Unhealthywhen 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 byProjectionsUnitOfWork.Stratara.Shared— for diagnostics + abstractions + resilience.Npgsql.EntityFrameworkCore.PostgreSQL,EFCore.NamingConventions,Microsoft.AspNetCore.Identity.EntityFrameworkCore,Microsoft.EntityFrameworkCore,Microsoft.Extensions.Diagnostics.HealthChecks,Pgvector.EntityFrameworkCore.
| Product | Versions 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. |
-
net10.0
- EFCore.NamingConventions (>= 10.0.1)
- Microsoft.AspNetCore.Identity.EntityFrameworkCore (>= 10.0.11)
- Microsoft.EntityFrameworkCore (>= 10.0.11)
- Microsoft.Extensions.DependencyInjection (>= 10.0.11)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 10.0.11)
- Microsoft.Extensions.Hosting (>= 10.0.11)
- Npgsql.EntityFrameworkCore.PostgreSQL (>= 10.0.3)
- Pgvector.EntityFrameworkCore (>= 0.3.0)
- Stratara.Projections (>= 4.4.3)
- Stratara.Shared (>= 4.4.3)
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.4.4 | 50 | 10/10/2026 |
| 4.4.3 | 67 | 10/10/2026 |
| 4.4.2 | 336 | 10/2/2026 |
| 4.4.1 | 400 | 9/29/2026 |
| 4.4.0 | 167 | 9/27/2026 |
| 4.3.1 | 168 | 9/25/2026 |
| 4.3.0 | 326 | 9/23/2026 |
| 4.2.0 | 206 | 9/18/2026 |
| 4.1.1 | 140 | 9/16/2026 |
| 4.1.0 | 132 | 9/16/2026 |
| 4.0.4 | 951 | 9/14/2026 |
| 4.0.3 | 200 | 9/3/2026 |
| 4.0.2 | 623 | 9/3/2026 |
| 4.0.1 | 340 | 9/2/2026 |
| 4.0.0 | 187 | 8/31/2026 |
| 4.0.0-preview.1 | 83 | 8/31/2026 |
| 3.4.0 | 167 | 8/28/2026 |
| 3.3.0 | 148 | 8/25/2026 |
| 3.2.3 | 150 | 8/22/2026 |
| 3.2.2 | 150 | 8/14/2026 |
A release about facts recorded in the wrong place and replays nobody dared to start. A handler can now append
only if the stream is still where it read it, so a fact decided on a stream's earlier state is no longer recorded
after one that contradicts it. A replay request starts one replay instead of one per host, its outcome stays
readable after it ends, and on PostgreSQL a failed replay restores the read models it emptied. A new stream's
owner can be stated at creation, and a subscription nobody consumes is reported. Everything new is opt-in or
additive; no migration is needed. Three optional settings are new — and hosts that run the replay worker are
upgraded together (see *Changed*).
### Added
- **An append can be made on the condition of the version the handler read.** `AppendAsync` numbers an
event after whatever the stream holds when the append is made, so a write that landed between a
handler's read and its append went unnoticed and the handler's fact was recorded after it — after a
stream's end, for example, which then stops every later projection replay. `IEventSource` gains
`AppendAtVersionAsync<TAggregate>(streamId, expectedVersion, @event)` and
`AppendRangeAtVersionAsync<TAggregate>(streamId, expectedVersion, events)`: if another writer has moved
the stream past `expectedVersion`, `SaveChangesAsync` throws `ConcurrencyException` — naming the stream that
moved — and records nothing, and the bus redelivers as for any conflict. A version the stream has not reached,
or a negative one, is refused at the append with `ArgumentOutOfRangeException`. The members have default
implementations that throw `NotSupportedException`, so an implementation of `IEventSource` outside the
framework still compiles.
- **`EventSourcing:AppendAgainstAggregatedVersion`** (default `false`). With it on, an append to a stream
the handler rebuilt through `IAggregationService.AggregateAsync` in the same scope is made on the
condition of the version that rebuild saw — every read-then-write handler gets the protection without a
code change. The condition is the version of the first rebuild of a stream in the scope; a rebuild bounded
with `toVersion` sets none; a rebuild that found no stream expects it still not to exist; a successful save
ends it on the streams it wrote. With the option off nothing is recorded. The cost: a handler appending to a
stream another writer touches concurrently gets a conflict where it used to succeed, and on the `IMediator`
path the caller sees it.
- **A new stream's owner can be stated at creation.** `IEventSource.CreateOnBehalfOfAsync<TAggregate>(streamId,
@event, subject)` creates the stream with the owner the subject states, which every later event keeps. Until
now the explicit route existed for appends only. A default implementation built on `ExistsAsync` and
`AppendOnBehalfOfAsync` keeps implementations outside the framework compiling.
- **`EventSourcing:NewStreamOwnerFromSession`** — `Allow` (default), `Warn` or `Refuse` — decides what happens when
a new stream's first event would take its owner from the session: as before, as before plus a warning `102_007`
(once per stream and batch), or a refusal before anything is staged. Stated owners, creation events that carry a
tenant, and appends to existing streams are untouched. A value that names no policy fails the host's start with
an `OptionsValidationException`.
- **The outcome of the last replay is kept.** After a replay that succeeded, `GetProgress()` answered exactly
what it answered before any replay, so a status reader that polled saw a short replay only if a poll fell
inside it, and told the operator it had not begun. `ReplayProgress.LastReplay` is a new `ReplayOutcome` —
the request's id, when the replay started and ended, how many events it replayed, and whether it
`Succeeded`, `Failed` or was `Interrupted` — kept until the next replay ends. `ReplayProgress.RequestId`
names the replay that is running.
- **A replay request has an identity.** `IProjectionReplayState.RequestReplay(Guid requestId)` lets the
requester choose it and find it again; `Guid.Empty` is refused. `IProjectionReplayState` also gains
`SubscribeToReplayRequestAsync(Func<Guid, Task>)`, `TryActivate(Guid)` and `Complete(ReplayCompletion)`;
all four have default implementations, so an implementation outside the framework still compiles and
behaves as before.
- **A failed replay can restore the read models it emptied.** `AddReadModelRestore<TReadContext>()`
(PostgreSQL, `Stratara.EventSourcing.EntityFrameworkCore`) copies every table the read context maps — the read
models, the projection checkpoints and the record of forgotten tenants, as one snapshot — before a replay empties
anything. A replay that fails writes the copy back in one transaction, one that succeeds drops it, and one whose
host stopped leaves it for the next host that starts, which writes it back — and, while a replay still marked
active owns it, checks again every thirty seconds. A replay then ends in the rebuilt read models or exactly the
ones it started from. `ReplayOutcome.ReadModelsRestored` says it happened. Settings come from
`ProjectionReplay:Restore` (`Schema`, `ExcludedTables`, `AdditionalTables`, `CommandTimeout`); deployments that
share a read store give each its own `Schema`. New abstraction `IReadModelPreservation` in `Stratara.Projections`
for another store; without one registered a replay behaves as before. The copy costs one more read of the read
store before the replay and the disk to hold it twice while it runs. On a host without the shared Redis state, a
successful replay whose copy could not be dropped (`104_025`) is restored at the next start, because the outcome
that would say otherwise does not survive the restart.
- **A subscription nobody consumes is reported.** An established subscription keeps what is published to it until
something consumes it, so one whose worker is never deployed, or was retired, grows without end — and until now
nothing said so. On RabbitMQ, `EnsureSubscriptionAsync` logs `108_114` at Warning when the subscription already
holds at least `Messaging:UnconsumedSubscriptionWarningThreshold` messages (default 10 000; 0 turns it off; a
negative value fails the host's start) and no consumer is attached. Nothing is capped or discarded, and no queue
is declared with different arguments.
- **Log events:** `102_007` (Warning, a new stream's owner taken from the session), `104_019` (a request not run
because a replay is active), `104_020` (replay interrupted), `104_021` (read models preserved), `104_022`
(Warning, read models restored after a failure), `104_023` (Warning, an abandoned copy restored at start),
`104_025` (Warning, a copy that could not be dropped), `104_026` (Warning, the marking could not be renewed while
the replay prepares), `104_121` (Error, an outcome not recorded), `104_124` (Error, a write-back or a check at
start that failed; the copy is kept), `104_127` (Error, a request that could not be claimed), `108_114` (Warning,
a subscription nobody consumes).
### Changed
- **`AddEventSourcing()` reads the `EventSourcing` section itself** and validates it at start;
`AddWriteStore(configuration)` still binds it too, and the later registration wins if the two differ.
- **`CreateAsync` and `CreateRangeAsync` refuse a stream that already has events staged in the same batch** with
`InvalidOperationException` at the call, where the save used to fail later with a `ConcurrencyException`.
- **A replay renews its marking every second while it prepares** — preserves, empties and counts — so
`ProjectionReplay:LeaseSeconds` now has to outlast the slowest batch only, not the truncation before the first
progress report.
- **Rolling upgrade of replay hosts.** A host on an earlier release claims nothing: it runs every replay request it
receives, records no outcome, and its own requests carry no identity. Upgrade every host that runs the replay
worker before relying on one request starting one replay, or on `LastReplay`.
### Fixed
- **One replay request starts one replay.** Every host that runs the replay worker subscribes to the
request channel, and nothing claimed a request: with the coordination state in Redis, one request started
a full replay in every such host at once, all emptying and rebuilding the same read store, and two
requests in quick succession did the same within one host. A request is now claimed atomically with the
replay's marking; the other hosts pass it over, a host that receives it after the replay ended finds it
claimed, and a request that arrives while a replay is running — or while the host stops — starts nothing. A
replay that outlived its lease while another started records its outcome without touching the other's marking
or error message.
- **A replay stopped by its host ends as interrupted.** A replay cancelled between two batches logged
`104_006` "completed" with its partial count. It now ends as `Interrupted` and logs `104_020`, and the host's
stop waits, within its shutdown timeout, for the replay to record that. A cancellation that does not come from
the host stopping — a provider's own timeout — now ends the replay as `Failed` with its message, where it was
silently treated as a shutdown. Nothing the replay does after claiming a request can escape the coordination
store's callback any more.
- **The Redis-backed replay state reports `0` of `0` after a failure,** as the in-process one and the guide
always did; it kept showing the failed run's counters until their lease ran out.
- **A conflict in a batch that spans several streams names the stream another writer moved**, not the batch's first
entry; the conflict counter is tagged the same way.