Excalibur.Workflows.SqlServer 10.0.0-alpha.10

This is a prerelease version of Excalibur.Workflows.SqlServer.

dotnet add package Excalibur.Workflows.SqlServer --version 10.0.0-alpha.10

NuGet\Install-Package Excalibur.Workflows.SqlServer -Version 10.0.0-alpha.10

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="Excalibur.Workflows.SqlServer" Version="10.0.0-alpha.10" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Excalibur.Workflows.SqlServer" Version="10.0.0-alpha.10" />
                    

                            Directory.Packages.props

<PackageReference Include="Excalibur.Workflows.SqlServer" />
                    

                            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 Excalibur.Workflows.SqlServer --version 10.0.0-alpha.10

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Excalibur.Workflows.SqlServer, 10.0.0-alpha.10"

#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 Excalibur.Workflows.SqlServer@10.0.0-alpha.10

#: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=Excalibur.Workflows.SqlServer&version=10.0.0-alpha.10&prerelease
                    

                            Install as a Cake Addin

#tool nuget:?package=Excalibur.Workflows.SqlServer&version=10.0.0-alpha.10&prerelease
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Excalibur.Workflows.SqlServer

SQL Server implementation of the durable workflow signal inbox for Excalibur.

Part Of

The Excalibur durable-execution engine (Excalibur.Workflows).

What It Provides

A restart-durable IWorkflowSignalInbox. Admitted signals and their deduplication keys are persisted to SQL Server, so a signal admitted but not yet drained survives a process restart, and a producer's redelivery of the same (instanceId, signalId) after a restart is still deduplicated — the guarantee the in-process default cannot make.

Usage

services.AddWorkflows();

// Wire the durable SQL Server signal inbox (overrides the in-process default) and, in the same call,
// register the durability and tenant-scoping capability markers.
services.AddSqlServerWorkflowSignalInbox(options =>
{
    options.ConnectionString = configuration.GetConnectionString("Workflows")!;
    options.SchemaName = "dbo";
    options.TableName = "workflow_signal_inbox";
});

// Optional: fail host start if a durable signal inbox is NOT wired (a deployment that requires
// restart-durable signals opts in to this guard).
services.RequireDurableSignalInbox();

Multi-tenancy

The signal mailbox is tenant-owned: a signal belongs to the tenant whose workflow instance it addresses, and the durable table carries the tenant in its unique key (UNIQUE (TenantId, InstanceId, SignalId)), so two tenants using the same signal id are kept distinct rather than the second being treated as a duplicate. This registration attests that scoping as part of wiring the store.

A host that supplies its own IWorkflowSignalInbox — for example to run signal admission across processes — must register it through AddTenantAwareStore<IWorkflowSignalInbox, TInbox>() (or emit ITenantScopingCapability<IWorkflowSignalInbox> some other way) when multi-tenancy is enabled. A plainly registered inbox attests nothing and the host is refused at start, rather than silently deduplicating one tenant's signal against another tenant's key.

Schema

The store never creates its table at runtime. Run the shipped, idempotent DDL script against the target database before the first signal is admitted:

Scripts/001_CreateWorkflowSignalInboxSchema.sql

It creates the table below (shown here for reference; the script is the source of truth and is safe to re-run):

CREATE TABLE [dbo].[workflow_signal_inbox] (
    Sequence    BIGINT IDENTITY(1,1) NOT NULL PRIMARY KEY,
    TenantId    NVARCHAR(64)  COLLATE Latin1_General_BIN2 NOT NULL,
    InstanceId  NVARCHAR(200)        NOT NULL,
    SignalId    NVARCHAR(200)        NOT NULL,
    SignalName  NVARCHAR(200)        NOT NULL,
    PayloadJson NVARCHAR(MAX)        NULL,
    CONSTRAINT UQ_workflow_signal_inbox UNIQUE (TenantId, InstanceId, SignalId)
);

The UNIQUE (TenantId, InstanceId, SignalId) constraint is required for correctness, not just hygiene: it is what makes a producer's redelivery of an already-admitted signal a no-op. Omit it and every redelivery is admitted a second time, silently breaking exactly-once signal delivery.

TenantId is part of that constraint rather than a filter applied over it, and the distinction matters in both directions. A redelivery within one tenant still collides and is still refused. But two tenants presenting the same (InstanceId, SignalId) are two different signals, and under a constraint that omitted the tenant the second was refused admission and silently discarded — its workflow then waited for a signal the system had received and thrown away, with no error and no row left behind. The host verifies this exact three-column constraint at startup and refuses to start without it; if your table predates the tenant column, apply Scripts/002_MakeWorkflowSignalInboxTenantTotal.sql before deploying. Sequence is an IDENTITY arrival column: drain order is the monotonic append sequence, never a wall-clock timestamp, so consumption is deterministic and reproducible.

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.

net10.0
- AspNetCore.HealthChecks.SqlServer (>= 9.0.0)
- Ben.Demystifier (>= 0.4.1)
- CloudNative.CloudEvents (>= 2.8.0)
- CloudNative.CloudEvents.SystemTextJson (>= 2.8.0)
- Cronos (>= 0.12.0)
- Dapper (>= 2.1.72)
- Excalibur.Data.SqlServer (>= 10.0.0-alpha.10)
- Excalibur.Dispatch.Abstractions (>= 10.0.0-alpha.10)
- Excalibur.Workflows.Abstractions (>= 10.0.0-alpha.10)
- FluentValidation (>= 12.1.1)
- FluentValidation.DependencyInjectionExtensions (>= 12.1.1)
- IdentityModel (>= 7.0.0)
- JsonNet.ContractResolvers (>= 2.0.0)
- Medo.Uuid7 (>= 3.2.0)
- MemoryPack (>= 1.21.4)
- Microsoft.ApplicationInsights (>= 3.1.0)
- Microsoft.Data.SqlClient (>= 7.0.0)
- Microsoft.Extensions.Caching.Abstractions (>= 10.0.10)
- Microsoft.Extensions.Caching.Memory (>= 10.0.10)
- Microsoft.Extensions.Configuration (>= 10.0.10)
- Microsoft.Extensions.Configuration.Abstractions (>= 10.0.10)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.10)
- Microsoft.Extensions.Configuration.CommandLine (>= 10.0.10)
- Microsoft.Extensions.Configuration.EnvironmentVariables (>= 10.0.10)
- Microsoft.Extensions.Configuration.Json (>= 10.0.10)
- Microsoft.Extensions.DependencyInjection (>= 10.0.10)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.10)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 10.0.10)
- Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions (>= 10.0.10)
- Microsoft.Extensions.Hosting (>= 10.0.10)
- Microsoft.Extensions.Hosting.Abstractions (>= 10.0.10)
- Microsoft.Extensions.Http (>= 10.0.10)
- Microsoft.Extensions.Logging (>= 10.0.10)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.10)
- Microsoft.Extensions.Logging.Console (>= 10.0.10)
- Microsoft.Extensions.ObjectPool (>= 10.0.10)
- Microsoft.Extensions.Options (>= 10.0.10)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 10.0.10)
- Microsoft.Extensions.Options.DataAnnotations (>= 10.0.10)
- Microsoft.IdentityModel.Tokens (>= 8.17.0)
- OpenTelemetry (>= 1.15.3)
- OpenTelemetry.Api (>= 1.15.3)
- OpenTelemetry.Extensions.Hosting (>= 1.15.3)
- Polly (>= 8.6.6)
- System.IdentityModel.Tokens.Jwt (>= 8.17.0)
- System.Threading.RateLimiting (>= 10.0.7)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
10.0.0-alpha.10	54	9/6/2026
10.0.0-alpha.9	55	8/31/2026
10.0.0-alpha.8	62	8/14/2026
10.0.0-alpha.7	65	8/13/2026
10.0.0-alpha.6	78	8/11/2026
10.0.0-alpha.5	53	8/10/2026

Release notes and versioning policy: https://docs.excalibur-dispatch.dev/docs/migration/version-upgrades