Stratara.Orleans.EntityFrameworkCore 4.5.0

Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package Stratara.Orleans.EntityFrameworkCore --version 4.5.0
                    
NuGet\Install-Package Stratara.Orleans.EntityFrameworkCore -Version 4.5.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Stratara.Orleans.EntityFrameworkCore" Version="4.5.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Stratara.Orleans.EntityFrameworkCore" Version="4.5.0" />
                    
Directory.Packages.props
<PackageReference Include="Stratara.Orleans.EntityFrameworkCore" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Stratara.Orleans.EntityFrameworkCore --version 4.5.0
                    
#r "nuget: Stratara.Orleans.EntityFrameworkCore, 4.5.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Stratara.Orleans.EntityFrameworkCore@4.5.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Stratara.Orleans.EntityFrameworkCore&version=4.5.0
                    
Install as a Cake Addin
#tool nuget:?package=Stratara.Orleans.EntityFrameworkCore&version=4.5.0
                    
Install as a Cake Tool

Stratara.Orleans.EntityFrameworkCore

Derived. The behaviour described here is specified under openspec/specs/, in the orleans-execution and event-sourcing-store capabilities. Those specifications are the source; this page explains them.

License: MIT.

Entity Framework Core persistence for the Stratara Orleans execution model: the readers that return the event store in commit order and the checkpoint store the store-reading projections and sagas resume from. The columns and tables they need are declared by the framework's write and read contexts in Stratara.EventSourcing.EntityFrameworkCore, so a context derived from those carries them without further configuration.

What's in the box

Part What it does
PostgresTransactionIdReader<TContext> Reads in commit order on PostgreSQL, adding no work to an append
PortableCounterReader<TContext>, AddStrataraPortableCounterReader<TWriteContext>() Reads in commit order on any relational provider, through a per-partition counter; verified on PostgreSQL and on SQLite
PartitionCounterInterceptor Maintains the per-partition counter inside the appending transaction — in every process that appends
PartitionCounterBackfill Positions unpositioned entries after the partition's counter, never moving a position already handed out, so checkpoints stay true
CommitTransactionIdBackfill Stamps the entries a PostgreSQL store held before the commit record existed, in append order and bounded batches, once
AddStrataraProjectionCheckpoints<TReadContext>() Keeps the checkpoints in the read context
AddStrataraIntentStore<TWriteContext>() Records the commands the execution model's dispatcher accepts, in the outbox table, and claims a due batch in two statements
AddStrataraExecutionModelReset<TReadContext>() Clears reminders, membership, directory and the host's checkpoints while no silo runs

Quick start

The read side — projections that read the store in commit order from a checkpoint:

builder.Services
    .AddSingleton<ICommittedPositionReader, PostgresTransactionIdReader<AppWriteDbContext>>()
    .AddStrataraProjectionCheckpoints<AppReadDbContext>()
    .AddStrataraProjectionGrains();

The write side — commands recorded before the dispatch returns and resumed after a crash:

builder.Services
    .AddStrataraOrleansCommandDispatcher()
    .AddStrataraIntentStore<AppWriteDbContext>()
    .AddStrataraSingletonWork<OutboxDrainWork>(OutboxDrainWork.WorkName);

The record is committed in a transaction of its own, not with what the caller writes.

Product 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Stratara.Orleans.EntityFrameworkCore:

Package Downloads
Stratara.Testing.Orleans

Run the Stratara Orleans execution model in a test's own process — one silo with in-memory reminders and grain directory, the real write stack, commit-order reader and checkpoint store on in-memory SQLite, and every period shortened to seconds. Register handlers, projections, sagas and timers with the production calls; no cluster, broker or database server. Builds on Stratara.Testing.EntityFrameworkCore.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
4.8.0 152 11/6/2026
4.7.1 134 11/5/2026
4.7.0 444 10/30/2026
4.6.1 116 10/29/2026
4.6.0 178 10/28/2026
4.5.0 269 10/28/2026
4.4.10 216 10/26/2026
4.4.9 124 10/26/2026
4.4.8 261 10/24/2026
4.4.7 124 10/23/2026
4.4.6 219 10/22/2026
4.4.5 107 10/14/2026
4.4.4 111 10/10/2026
4.4.3 116 10/10/2026
4.4.2 243 10/2/2026
4.4.1 130 9/29/2026
4.4.0 106 9/27/2026
4.3.1 118 9/25/2026
4.3.0 155 9/23/2026
4.2.0 178 9/18/2026
Loading failed

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.