Stratara.EventSourcing.EntityFrameworkCore
3.2.2
dotnet add package Stratara.EventSourcing.EntityFrameworkCore --version 3.2.2
NuGet\Install-Package Stratara.EventSourcing.EntityFrameworkCore -Version 3.2.2
<PackageReference Include="Stratara.EventSourcing.EntityFrameworkCore" Version="3.2.2" />
<PackageVersion Include="Stratara.EventSourcing.EntityFrameworkCore" Version="3.2.2" />
<PackageReference Include="Stratara.EventSourcing.EntityFrameworkCore" />
paket add Stratara.EventSourcing.EntityFrameworkCore --version 3.2.2
#r "nuget: Stratara.EventSourcing.EntityFrameworkCore, 3.2.2"
#:package Stratara.EventSourcing.EntityFrameworkCore@3.2.2
#addin nuget:?package=Stratara.EventSourcing.EntityFrameworkCore&version=3.2.2
#tool nuget:?package=Stratara.EventSourcing.EntityFrameworkCore&version=3.2.2
Stratara.EventSourcing.EntityFrameworkCore
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.2.2)
- Stratara.Shared (>= 3.2.2)
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.
API keys can now be bootstrapped. Issuance always generated the key itself, which does not fit the
setups where server and caller have to share a key *before* either starts — container orchestration,
CI provisioning, self-hosted bundles, end-to-end test hosts. This release adds an import path for a
key the caller already holds, plus the canonical key format as public API so callers generate values
instead of inventing them.
### Added
- **`IApiKeyStore.ImportAsync` — store a machine key whose raw value the caller already holds.**
Issuance generates the key itself, which is the wrong shape when server and caller must share it
*before* either boots: container orchestration, CI provisioning, self-hosted bundles, end-to-end
test hosts. Without this path, consumers bypassed the store and reimplemented its internals (the
digest format and the machine-key membership row) — a copy that keeps compiling after the store
changes and fails as a runtime 401. Import is idempotent, so it can run unconditionally on every
boot: a value that is already stored returns the existing descriptor and the stored key is never
mutated, so a changed configuration cannot escalate a key's roles or extend its expiry unnoticed.
Revoked, expired, and foreign-tenant values are rejected rather than silently adopted, and
concurrent replicas racing the same first import converge on one key. Machine keys only —
`ApiKeyImportRequest` carries no `UserId`.
- **`ApiKeyFormat` (`Stratara.Abstractions.ApiKeys`) — the canonical raw-key format as public API.**
`CreateRawKey()` generates `stk_` plus the Base64Url encoding of 32 CSPRNG bytes; `IsWellFormed()`
checks that shape. `ImportAsync` accepts only well-formed values: the store keeps its stored
digest unsalted because a generated key carries 256 bits of entropy, and a hand-picked value would
quietly invalidate that. Generate keys out of band with `CreateRawKey()` and keep them in a secret
store — the type lives in the abstractions package so host-builder and orchestration projects can
reach it without referencing the storage implementation.
- **`InMemoryApiKeyStore` (`Stratara.Testing`) — the drop-in double for the API-key store**,
mirroring issuance, import, fail-closed validation, revocation, and the erasure sweeps, and
materializing machine keys into a membership store you can share and inspect.
### Changed
- **API-key lifecycle events are now logged** (`Stratara.Diagnostics` event-ID range 116_000):
import, idempotent repeat, and a repeat that supplied different parameters. Key ids and tenant
ids only — never the raw key or its digest.
- **For implementers of `IApiKeyStore`:** the interface gained `ImportAsync`. Custom implementations
need the new member; callers are unaffected.