EventStoreCore.SqlServer 1.0.2-beta.2

EventStoreCore.SqlServer

SQL Server persistence configuration for EventStoreCore using EF Core.

Setup

Register your application DbContext, configure the EventStore model in OnModelCreating, and tell EventStoreCore to reuse that context:

using EventStoreCore;
using EventStoreCore.SqlServer;
using Microsoft.EntityFrameworkCore;

public sealed class AppDbContext(DbContextOptions<AppDbContext> options)
    : DbContext(options)
{
    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        base.OnModelCreating(modelBuilder);
        modelBuilder.UseEventStore();
    }
}

services.AddDbContext<AppDbContext>(
    options => options.UseSqlServer(connectionString));

services.AddEventStore(builder =>
{
    builder.ExistingDbContext<AppDbContext>();
});

ExistingDbContext<TDbContext>() does not create or migrate a separate database. EventStoreCore uses the application-owned context, connection, transaction, and migrations. Add migrations from the application project after calling UseEventStore().

Provider behavior

• Event payloads and snapshots use SQL Server nvarchar(max) columns.
• Stream identity is (Id, StreamType, TenantId).
• Event ordering within a stream is protected by a unique (StreamId, StreamType, TenantId, Version) index.
• EventId is a generated or caller-supplied GUID with a global uniqueness constraint; consumers must not rely on GUID ordering.
• Global event-log reads use the generated Events.Sequence primary key plus filtered sequence indexes for tenant, logical stream type, and logical event type.
• Registered event-store and entity-outbox writers acquire a transaction-owned SQL Server application lock before generated sequence allocation and hold it through commit. This makes sequence checkpoints gap-safe; rollbacks can leave gaps but lower sequences cannot commit late.
• Inline projections share the append transaction. Subscription and eventual projection delivery is at-least-once.
• Daemons require an application-provided IDistributedLockProvider.

Provider-specific database migrations remain application owned. Review generated migrations when upgrading EventStoreCore, especially changes to keys, indexes, or required metadata columns. Existing databases need a migration that makes Events.Sequence the generated primary key and adds the unique stream-version index.

The commit-ordering change itself has no schema migration. Upgrade every writer for a database together; a mixed deployment or direct SQL writer that does not acquire the application lock can invalidate the checkpoint fence. Sequence- allocating transactions serialize until commit, so keep explicit transactions short and replay or rebuild consumers whose old checkpoints may already have skipped an event. A direct SQL writer participates by acquiring an exclusive transaction-owned sp_getapplock on the resource EventStoreCore.SequenceCommitOrder before the first insert into Events or OutboxMessages.