Table of Contents

Class OutboxBuilderSqlServerExtensions

Namespace
Excalibur.Outbox.SqlServer
Assembly
Excalibur.Outbox.SqlServer.dll

Extension methods for configuring SQL Server provider on IOutboxBuilder.

public static class OutboxBuilderSqlServerExtensions
Inheritance
OutboxBuilderSqlServerExtensions
Inherited Members

Remarks

These extensions provide fluent provider selection following the canonical CDC builder pattern (see CdcBuilderSqlServerExtensions).

Methods

UseSqlServer(IOutboxBuilder, OutboxMetadataSerialization, Action<ISqlServerOutboxBuilder>)

Selects SQL Server storage with explicit source-generated header metadata.

public static IOutboxBuilder UseSqlServer(this IOutboxBuilder builder, OutboxMetadataSerialization metadataSerialization, Action<ISqlServerOutboxBuilder> configure)

Parameters

builder IOutboxBuilder

The outbox builder.

metadataSerialization OutboxMetadataSerialization

Store-specific metadata, independent of any common default.

configure Action<ISqlServerOutboxBuilder>

Provider connection and processing configuration.

Returns

IOutboxBuilder

The builder.

UseSqlServer(IOutboxBuilder, Action<ISqlServerOutboxBuilder>)

Configures the outbox to use SQL Server as the storage provider.

[RequiresUnreferencedCode("Legacy outbox registration may select reflection serialization. Use the overload with explicit OutboxMetadataSerialization for generated metadata.")]
[RequiresDynamicCode("Legacy outbox registration may select runtime code generation. Use the overload with explicit OutboxMetadataSerialization.")]
[SuppressMessage("Maintainability", "CA1506:AvoidExcessiveClassCoupling", Justification = "DI composition root wires many provider types by design; matches the store's existing suppression.")]
public static IOutboxBuilder UseSqlServer(this IOutboxBuilder builder, Action<ISqlServerOutboxBuilder> configure)

Parameters

builder IOutboxBuilder

The outbox builder.

configure Action<ISqlServerOutboxBuilder>

Action to configure SQL Server-specific options via the fluent builder.

Returns

IOutboxBuilder

The builder for fluent chaining.

Examples

// Connection string
services.AddExcalibur(x => x.AddOutbox(outbox =>
{
    outbox.UseSqlServer(sql =>
    {
        sql.ConnectionString("Server=.;Database=MyDb;Trusted_Connection=True;")
           .SchemaName("Messaging")
           .TableName("OutboxMessages");
    })
    .EnableBackgroundProcessing();
}));

// Named connection string
services.AddExcalibur(x => x.AddOutbox(outbox =>
{
    outbox.UseSqlServer(sql =>
    {
        sql.ConnectionStringName("OutboxDb");
    });
}));

// Connection factory (Azure Managed Identity)
services.AddExcalibur(x => x.AddOutbox(outbox =>
{
    outbox.UseSqlServer(sql =>
    {
        sql.ConnectionFactory(sp =>
        {
            var config = sp.GetRequiredService<IConfiguration>();
            var connStr = config.GetConnectionString("OutboxDb")!;
            return () => new SqlConnection(connStr);
        });
    });
}));

// Bind from appsettings.json
services.AddExcalibur(x => x.AddOutbox(outbox =>
{
    outbox.UseSqlServer(sql =>
    {
        sql.BindConfiguration("Outbox:SqlServer");
    });
}));

Exceptions

ArgumentNullException

Thrown when builder or configure is null.

WithSqlServerDeadLetterQueue(IOutboxBuilder, Action<SqlServerDeadLetterQueueOptions>)

Configures the outbox to use SQL Server dead letter queue.

public static IOutboxBuilder WithSqlServerDeadLetterQueue(this IOutboxBuilder builder, Action<SqlServerDeadLetterQueueOptions> configure)

Parameters

builder IOutboxBuilder

The outbox builder.

configure Action<SqlServerDeadLetterQueueOptions>

Action to configure dead letter queue options.

Returns

IOutboxBuilder

The builder for fluent chaining.

Exceptions

ArgumentNullException

Thrown when builder or configure is null.