Yautbox.Mssql
1.0.1
dotnet add package Yautbox.Mssql --version 1.0.1
NuGet\Install-Package Yautbox.Mssql -Version 1.0.1
<PackageReference Include="Yautbox.Mssql" Version="1.0.1" />
<PackageVersion Include="Yautbox.Mssql" Version="1.0.1" />
<PackageReference Include="Yautbox.Mssql" />
paket add Yautbox.Mssql --version 1.0.1
#r "nuget: Yautbox.Mssql, 1.0.1"
#:package Yautbox.Mssql@1.0.1
#addin nuget:?package=Yautbox.Mssql&version=1.0.1
#tool nuget:?package=Yautbox.Mssql&version=1.0.1
Yautbox.Mssql
SQL Server infrastructure provider for Yautbox. It stores outbox messages in MSSQL, applies schema migrations on startup, and supports distributed locks for sequential execution.
Features
- SQL Server storage with schema migrations
- Distributed lock for
ExecutionPolicy.Sequential - Configurable schema name and JSON serialization
- Cleanup batching for safe-deleted records
Installation
NuGet (if published):
dotnet add package Yautbox.Mssql
From source:
dotnet add <your-app>.csproj reference src/Yautbox.Mssql/Yautbox.Mssql.csproj
Quick start
using Microsoft.Extensions.DependencyInjection;
using Yautbox.Extensions.Ioc;
using Yautbox.Mssql.Extensions;
services.AddOutbox(builder => builder.UseMssql(
connectionString: "Server=.;Database=yautbox;Trusted_Connection=True;"));
services.AddOutboxHandler<OrderPlaced, OrderPlacedHandler>();
Options
MssqlStoreOptions:
SchemaName(default: "outbox")CleanupBatchSize(default: 1000)ConfigureJsonOptions(customizeJsonSerializerOptions)
Example:
using System.Text.Json;
using Yautbox.Mssql.Extensions;
using Yautbox.Mssql.Extensions.Configurator;
services.AddOutbox(builder => builder.UseMssql(
connectionString: "...",
options: new MssqlStoreOptions
{
SchemaName = "messaging",
CleanupBatchSize = 2000,
ConfigureJsonOptions = (json, _) => json.PropertyNamingPolicy = JsonNamingPolicy.CamelCase
}));
Connection factory
If you need custom connection creation (for example, Azure SQL with custom tokens), register your own factory and use the generic overload:
using Yautbox.Mssql.Extensions;
using Yautbox.Mssql.Infrastructure.Database;
public sealed class MyConnectionFactory : IOutboxConnectionFactory
{
public string GetConnectionString() => "...";
public Task<DbConnection> GetConnectionAsync(CancellationToken ct) => /* ... */;
}
services.AddOutbox(builder => builder.UseMssql<MyConnectionFactory>());
Migrations and readiness
This provider runs FluentMigrator migrations on startup and waits for readiness before handlers begin polling. The database user must have permissions to create schemas, tables, and types.
Notes
ExecutionPolicy.Sequentialuses a SQL Server distributed lock to ensure single active processing per identifier.DeletePolicy.Safemarks records as deleted; cleanup is performed by the background cleaner whenBackupIntervalis set.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. 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
- DistributedLock.SqlServer (>= 1.0.6)
- FluentMigrator.Runner (>= 7.1.0)
- Microsoft.Data.SqlClient (>= 6.1.4)
- Yautbox (>= 1.0.1)
-
net8.0
- DistributedLock.SqlServer (>= 1.0.6)
- FluentMigrator.Runner (>= 7.1.0)
- Microsoft.Data.SqlClient (>= 6.1.4)
- Yautbox (>= 1.0.1)
-
net9.0
- DistributedLock.SqlServer (>= 1.0.6)
- FluentMigrator.Runner (>= 7.1.0)
- Microsoft.Data.SqlClient (>= 6.1.4)
- Yautbox (>= 1.0.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.