Stratara.EventSourcing.EntityFrameworkCore
4.5.0
Prefix Reserved
See the version list below for details.
dotnet add package Stratara.EventSourcing.EntityFrameworkCore --version 4.5.0
NuGet\Install-Package Stratara.EventSourcing.EntityFrameworkCore -Version 4.5.0
<PackageReference Include="Stratara.EventSourcing.EntityFrameworkCore" Version="4.5.0" />
<PackageVersion Include="Stratara.EventSourcing.EntityFrameworkCore" Version="4.5.0" />
<PackageReference Include="Stratara.EventSourcing.EntityFrameworkCore" />
paket add Stratara.EventSourcing.EntityFrameworkCore --version 4.5.0
#r "nuget: Stratara.EventSourcing.EntityFrameworkCore, 4.5.0"
#:package Stratara.EventSourcing.EntityFrameworkCore@4.5.0
#addin nuget:?package=Stratara.EventSourcing.EntityFrameworkCore&version=4.5.0
#tool nuget:?package=Stratara.EventSourcing.EntityFrameworkCore&version=4.5.0
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.5.0)
- Stratara.Shared (>= 4.5.0)
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 | 0 | 11/6/2026 |
| 4.7.1 | 77 | 11/5/2026 |
| 4.7.0 | 571 | 10/30/2026 |
| 4.6.1 | 147 | 10/29/2026 |
| 4.6.0 | 208 | 10/28/2026 |
| 4.5.0 | 296 | 10/28/2026 |
| 4.4.10 | 243 | 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 reads that cost more the more the store holds. Loading an aggregate read its stream and its
snapshot through every partition of the store, so every command grew slower as the store grew. A write context
that applies `ApplyGlobalEntityConfiguration()` also lost the index on the event stream's sequence number, which
left the hashing worker, reading in sequence order and the store's head without an index. Every read of one stream
is now confined to its partition, and the write model declares the indexes it was missing, whichever key the
context gives the event stream. No public type or member changes, but the write context needs a migration, and a
write context that overrides `ConfigureConventions` without calling `base` is now refused at start-up.
**Upgrading:**
- **If your store holds events written before 3.0.0, check it first.** Releases before 3.0.0 worked out a
stream's partition with another formula, and the store now reads a stream only in the partition its id gives.
The composition guide (*A store written before 3.0.0*) gives a check that needs nothing but the database, and a
repair that moves the rows to their partition without touching the hash chain. A store that 3.0.0 or later wrote
from its start has nothing to check.
- **Generate an EF Core migration for your write context.** It adds up to three indexes and changes no table or
column: `ix_event_stream_entry_sequence_number` (unique, only where the event stream is not keyed by its sequence
number, which `ApplyGlobalEntityConfiguration()` makes it), `ix_event_stream_entry_unhashed_sequence_number`
(the entries whose hash is still null) and `ix_event_chain_anchor_sequence_number`. A host that does not migrate
fails at `Migrate()` on pending model changes, as with any schema addition.
- **If you declared these indexes yourself, remove your declarations first.** Under the same names and
definitions, the migration then leaves them as they are. A `(stream_id, version)` index you added to bridge the
stream reads is no longer needed and can be dropped.
- **On a large store, create the indexes without blocking writes.** The schema section of the composition guide
shows a migration that creates them with `CREATE INDEX CONCURRENTLY`.
- **A context that overrides `ConfigureConventions` calls `base.ConfigureConventions`.** `WriteDbContext<TContext>`
declares the sequence-number indexes there. A write context whose override does not call it is now refused when
its model is built, at start-up and in `dotnet ef` alike, with an `InvalidOperationException` that names the
context, so it never runs or migrates without the indexes. An override that was fine on 4.4 because the
method was empty there needs `base.ConfigureConventions(configurationBuilder);` now.
- **An entry or snapshot written outside the framework has to carry its stream's partition.** The store writes
each one with the partition its stream id gives it, through `BucketCalculator.GetBucketId`, and now reads one
stream only there. A row a host inserted itself under another partition, in a test fixture or an import, is no
longer found by the reads of its stream.
### Fixed
- **Loading an aggregate costs what its stream holds.** The reads of one stream (whether it exists, its first entry,
a range of versions, its current version) and of its snapshot conditioned on the stream id alone. The indexes that
serve them begin with the partition, so PostgreSQL before 18 walked the whole index for each of them, and a
command loads several. They now condition on the partition as well. On 300,000 events, reading a stream of three
went from 2,404 pages to 6.
- **The sequence number stays indexed under `ApplyGlobalEntityConfiguration()`.** That convention keys every entity
by `Id`, the event stream included, which dropped the key the framework had put on the sequence number. The
hashing worker's reads, reading the store in sequence order and the store's head then scanned the whole table on
every pass. The write model now declares a unique index on the sequence number wherever it is not the key.
- **The hashing worker reads only what is still unchained.** An index over the entries whose hash is null lets
each pass read the backlog and not the chained history before it. Its filter names the column your model maps the
hash to.
- **The latest anchor is found by index.** The hash chain's anchors are indexed by sequence number, so finding the
last one no longer sorts every anchor on every pass.