Stratara.EventSourcing.EntityFrameworkCore
4.6.1
Prefix Reserved
See the version list below for details.
dotnet add package Stratara.EventSourcing.EntityFrameworkCore --version 4.6.1
NuGet\Install-Package Stratara.EventSourcing.EntityFrameworkCore -Version 4.6.1
<PackageReference Include="Stratara.EventSourcing.EntityFrameworkCore" Version="4.6.1" />
<PackageVersion Include="Stratara.EventSourcing.EntityFrameworkCore" Version="4.6.1" />
<PackageReference Include="Stratara.EventSourcing.EntityFrameworkCore" />
paket add Stratara.EventSourcing.EntityFrameworkCore --version 4.6.1
#r "nuget: Stratara.EventSourcing.EntityFrameworkCore, 4.6.1"
#:package Stratara.EventSourcing.EntityFrameworkCore@4.6.1
#addin nuget:?package=Stratara.EventSourcing.EntityFrameworkCore&version=4.6.1
#tool nuget:?package=Stratara.EventSourcing.EntityFrameworkCore&version=4.6.1
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.13)
- Microsoft.EntityFrameworkCore (>= 10.0.13)
- Microsoft.Extensions.DependencyInjection (>= 10.0.13)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 10.0.13)
- Microsoft.Extensions.Hosting (>= 10.0.13)
- Npgsql.EntityFrameworkCore.PostgreSQL (>= 10.0.3)
- Pgvector.EntityFrameworkCore (>= 0.3.0)
- Stratara.Projections (>= 4.6.1)
- Stratara.Shared (>= 4.6.1)
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 | 80 | 11/6/2026 |
| 4.7.1 | 94 | 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 | 296 | 10/28/2026 |
| 4.4.10 | 244 | 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 |
A release about two costs of the Orleans execution model that grew with the deployment rather than with the work.
A commit woke every projection and saga reader of each partition it touched, whatever it had committed. Every one of
them read the new entries and wrote its checkpoint, also when it applied nothing, and every reader polled the store on
its own: every single-event command cost a checkpoint write per projection and saga, and an idle silo with many
consumers kept the store busy with hundreds of reads a second. A commit now costs work only for the readers it
concerns, and an idle silo asks the store a few questions per partition and poll interval.
A recorded command whose handler met a concurrency conflict waited for its hand-over to lapse, 30 seconds by default,
before the drain ran it again; on the bus a conflicting message is redelivered at once. It now runs again within
moments.
### Added
- **`ProjectionGrainOptions.IdleCheckpointInterval`** (default 30 seconds) bounds how long a projection's reader may
hold its checkpoint back past entries it applied nothing for. `TimeSpan.Zero` writes the checkpoint after every
batch, as before.
- **`ICommandIntentStore.CountConflictAsync`** counts a conflict and records it without giving the attempt back, and
answers how many conflicts the command has met. The default records through `RecordConflictAsync` and answers
`null`, so an intent store of your own compiles and behaves as before; the framework's store implements it.
### Changed
- **A commit wakes only the readers whose projection or saga applies one of its event types.** This holds for the
wake-up on a silo with a store-reading role and for `AddStrataraStoreWakeUps()`. Woken by every commit as before:
a stateful saga process, which decides from the event itself, and every reader when the commit holds an event type
the silo cannot resolve or whose upcaster refuses an empty payload, or when the host's upcaster pipeline is its own.
A multi-stream commit wakes, in each partition, the readers of the events it wrote there. In a test host with six
projections of which one applied the commit, ten commits cost 59 store reads before and only the applying
projection's reads now, and a commit nobody applies costs no read when it is made. A reader whose partition moved
past it still reads once at its next poll, and then waits again.
- **A projection's reader writes its checkpoint past entries it applied nothing for later**: with the next batch that
applies something, once `IdleCheckpointInterval` has passed, or when it deactivates. It answers waits for its
projection from the position it holds. A reader whose silo dies before the write reads those entries again and
applies nothing for them. A rebuild or a replay discards a position held back. A saga's reader writes its checkpoint
after every batch as before, because a saga added to a running deployment starts where the host's sagas have
written they read.
- **A poll reads the store only when its partition holds something past the reader's position.** Each silo asks the
store for a partition's head at most once per half poll interval, for all its readers. In the test host, 96 idle
readers polling every 500 ms read the store about 960 times in five seconds before and not at all now. A lost
wake-up is applied within about one and a half poll intervals rather than one. A committed position reader that
does not override `ICommittedPositionReader.HeadAsync` keeps polling as before.
- **A conflicting recorded command runs again at once.** The silo that ran it runs it again in a unit of work of its
own while it still holds the hand-over, pausing as the `ResilienceNames.ConcurrencyConflict` pipeline does (five
retries from 50 ms), on the aggregate activation's scheduler. A heavy command keeps its permit. Every conflict is
still recorded and counted, and the command runs again only while its conflicts stay within
`MessageRetryOptions.MaxConflictRequeues`, so a command that conflicts on every attempt runs as often as before and
is kept. The hand-over's attempt is given back once when the command leaves on a conflict, however often it ran.
After the pipeline's retries the drain resumes it as before.
- **`ExecutionModelTestHost.WaitForReadersAsync` waits for the readers' positions**, not their stored checkpoints,
so it returns once every reader has read to the head, whether or not it has written its checkpoint there yet.
**Upgrading:** nothing to do. Hosts and silos of 4.6.0 and of this release mix in a rolling deployment: the cluster
wake-up keeps its form, an earlier host's wake-up wakes every reader, and an earlier silo wakes every reader of a newer
host's wake-up. Checkpoints keep their form. An intent store of your own keeps the old timing after a conflict until
it implements `CountConflictAsync`.