Stratara.EventSourcing.EntityFrameworkCore
3.3.0
See the version list below for details.
dotnet add package Stratara.EventSourcing.EntityFrameworkCore --version 3.3.0
NuGet\Install-Package Stratara.EventSourcing.EntityFrameworkCore -Version 3.3.0
<PackageReference Include="Stratara.EventSourcing.EntityFrameworkCore" Version="3.3.0" />
<PackageVersion Include="Stratara.EventSourcing.EntityFrameworkCore" Version="3.3.0" />
<PackageReference Include="Stratara.EventSourcing.EntityFrameworkCore" />
paket add Stratara.EventSourcing.EntityFrameworkCore --version 3.3.0
#r "nuget: Stratara.EventSourcing.EntityFrameworkCore, 3.3.0"
#:package Stratara.EventSourcing.EntityFrameworkCore@3.3.0
#addin nuget:?package=Stratara.EventSourcing.EntityFrameworkCore&version=3.3.0
#tool nuget:?package=Stratara.EventSourcing.EntityFrameworkCore&version=3.3.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. 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:
// 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: the write-side factory was
AddNpsqlWriteDbContextFactory(missing theg) through 3.1.x. The correctly-spelledAddNpgsqlWriteDbContextFactoryis now the canonical name; the old spelling still compiles as an[Obsolete]alias and will be removed in the next major version.
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.8)
- Microsoft.EntityFrameworkCore (>= 10.0.8)
- Microsoft.Extensions.DependencyInjection (>= 10.0.8)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 10.0.8)
- Microsoft.Extensions.Hosting (>= 10.0.8)
- Npgsql.EntityFrameworkCore.PostgreSQL (>= 10.0.1)
- Pgvector.EntityFrameworkCore (>= 0.3.0)
- Stratara.Projections (>= 3.3.0)
- Stratara.Shared (>= 3.3.0)
NuGet packages (3)
Showing the top 3 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) 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. |
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 3.4.0 | 37 | 8/28/2026 |
| 3.3.0 | 101 | 8/25/2026 |
| 3.2.3 | 127 | 8/22/2026 |
| 3.2.2 | 123 | 8/14/2026 |
| 3.2.1 | 126 | 8/2/2026 |
| 3.2.0 | 146 | 7/18/2026 |
| 3.1.7 | 243 | 7/1/2026 |
| 3.1.6 | 565 | 6/22/2026 |
| 3.1.5 | 151 | 6/22/2026 |
| 3.1.4 | 161 | 6/15/2026 |
| 3.1.3 | 151 | 6/10/2026 |
| 3.1.2 | 166 | 6/5/2026 |
| 3.1.1 | 230 | 6/1/2026 |
| 3.1.0 | 134 | 5/30/2026 |
| 3.0.23 | 138 | 5/28/2026 |
Two capabilities the framework advertised but did not provide, and a set of guards for behaviour
that failed by succeeding. Crypto-shredding was the headline feature with no way to perform an
erasure; a web host had one mapper for the four failure types it has to answer for. Alongside those,
three things that reported success while doing nothing now report the truth instead — which is why
this release carries breaking entries despite adding no signature you have to change.
### Added
- **`ISubjectEraser` — an erasure is now one call.** Crypto-shredding was the framework's headline
capability with no way to perform an erasure: four separate sweeps existed, nothing composed them,
and a consumer had to know all four and get the order right themselves. `AddStrataraErasure()`
registers a composed operation that sweeps API keys, scoped settings, directory memberships and
key material — in that order, because a credential that still works can act mid-erasure and
shredding the key first makes every other plane unreadable. It reports what each plane covered,
and stops at the first failing plane rather than continuing, so a failed settings sweep is never
followed by the key shred. What it deliberately does **not** cover is documented: read models your
own projections built, unprotected event-stream data, the command audit log and outbox, and
system-wide key material.
- **`AddStrataraProblemDetails()` — one error shape for every framework rejection.** The framework
raises three failure types a web host has to answer for and shipped a mapper for one of them, so
both consumers wrote the missing half themselves. The new handler maps a validation rejection to
`400` with the failures grouped by the field each concerns, and an authorization refusal or
tenant-access denial to `403`, all as RFC 7807 problem responses. It is opt-in and converts nothing
else: any failure the framework did not raise propagates untouched, so a host keeping its own error
model simply does not register it.
- **`ITransaction.SaveChangesIdempotentAsync` — the idempotent-projection write the framework was
writing by hand.** A projection sees the same event twice under at-least-once delivery, and a row
can vanish between the read and the write; neither is a fault. The helper commits, and on a
concurrency conflict asks whether the write's target still exists: gone means a concurrent bundle
reached the same end state and the commit is satisfied, still there means a real conflict and the
exception is rethrown so the bundle fails as it must. `TenantProjection` now uses it — and gains
the distinction, having previously swallowed every conflict.
- **Three guides that did not exist**: evolving an event schema, using the resilience policies, and
writing an update handler. Each leads with the constraint that costs most to discover late — an
upcaster sees ciphertext and snapshots are never upcasted; a retry re-runs your handler; a property
missing on either side of an update is ignored in silence.
### Changed
- **BREAKING — the development key store no longer pretends to erase.** `DummyKeyStore.RevokeAsync`
and `EraseScopeAsync` completed successfully and shredded nothing, so a consumer exercising an
erasure path in development got a green result and no shredding. Both now throw
`NotSupportedException`. The store derives a single key from a fixed pass-phrase and holds no key
material it could destroy; reporting success was the defect. Register a real `IKeyStore` — the
file-backed envelope store, an HSM, Key Vault, KMS — to exercise crypto-shredding.
- **BREAKING — a host refuses to start when an aggregate cannot be restored from its snapshot.** An
aggregate property that holds state and cannot be set from outside the type is not restored by a
snapshot: the aggregate rebuilds, the events after the snapshot apply, and only what the snapshot
held for that property is gone — silently, and worse the better snapshotting works.
`AddEventSourcing()` now scans the registered aggregates at start-up and fails, naming the
aggregate and the property. Give it a public setter; aggregates use `public set` rather than
`private set` precisely because snapshot deserialization needs it. Computed properties are
unaffected — they hold no state and are recomputed after a restore.
- **BREAKING — test-support packages are now kept out of projects that are not test projects.** Both
`Stratara.Testing` and `Stratara.Testing.EntityFrameworkCore` ship an MSBuild check that fails the
build with `STRATARA1001` when a referencing project is neither a test project nor opted out. Set
`StrataraAllowTestSupportOutsideTests=true` for a deliberate exception such as a sample or a
benchmark. The check travels with the package, so it fires on a `PackageReference` and not on a
project reference inside a single solution.
- **`AddStrataraTestingEventStore` refuses to register into a running host.** It wires an in-memory
SQLite database and in-memory doubles, which would start successfully in production and lose every
write. It now throws `InvalidOperationException` when a registered `IHostEnvironment`, or
`DOTNET_ENVIRONMENT` / `ASPNETCORE_ENVIRONMENT`, names anything other than `Development`. Where no
environment is stated at all — the ordinary unit test, which has no host — the call is allowed, so
existing test suites are unaffected.
- **`command.duration` is documented as what it measures.** It was described as end-to-end command
latency and is recorded only in the outbox worker, so a host dispatching in-process saw an empty
histogram and a host doing both saw half its traffic. The instrument and its tags are unchanged —
only the description.
- **Settings resolve in one read per scope instead of one per setting and scope.** Twenty inherited
settings over a four-scope fallback chain were up to eighty store round trips; each scope is now
loaded once. Same fallback order and same results.
- **Snapshot evaluation no longer opens an extra transaction per stream** on the write hot path.
### Deprecated
- **`UseAuthorizationExceptionTo403()`, removed in the next major version.** It maps two refusals to
a bare status code with no body; `AddStrataraProblemDetails()` supersedes it with a full problem
response that also covers validation. It keeps working for now — the compiler warning is the
migration notice. Do not register both: the middleware answers first and the handler never sees the
exception.