Table of Contents

Class SqlServerDeadLetterQueueOptions

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

Configuration options for SQL Server-based dead letter queue storage.

public sealed class SqlServerDeadLetterQueueOptions
Inheritance
SqlServerDeadLetterQueueOptions
Inherited Members

Properties

ApplicationName

Gets or sets the application name used for connection pool isolation.

public string ApplicationName { get; set; }

Property Value

string

The application name for pool isolation. Defaults to "Excalibur.DeadLetterQueue".

Remarks

When set, this value is applied to the Application Name property of the connection string to provide separate ADO.NET connection pools per subsystem.

CommandTimeoutSeconds

Gets or sets the command timeout in seconds for SQL operations.

public int CommandTimeoutSeconds { get; set; }

Property Value

int

The command timeout in seconds. Defaults to 30.

ConnectionString

Gets or sets the connection string for the SQL Server database.

[Required]
public string ConnectionString { get; set; }

Property Value

string

DefaultRetentionPeriod

Gets or sets the default retention period for dead letter entries. Entries older than this will be purged by cleanup operations.

public TimeSpan DefaultRetentionPeriod { get; set; }

Property Value

TimeSpan

The default retention period. Defaults to 30 days.

QualifiedTableName

Gets the fully qualified table name.

public string QualifiedTableName { get; }

Property Value

string

Remarks

Both identifiers are whitelisted through SqlIdentifierValidator before they are bracketed. An identifier cannot be parameterized, so validation is the only control available: bracket quoting alone does not contain a name carrying a ], which closes the quoting and leaves the remainder to be read as SQL. The value is the application's own configuration rather than request data, so this is defense-in-depth - and it is the same routing every event-store sibling already uses, which is the invariant the dead-letter queue was the sole exception to.

Exceptions

ArgumentException

Thrown when SchemaName or TableName is not a valid SQL identifier.

SchemaName

Gets or sets the schema name for the dead letter queue table.

public string SchemaName { get; set; }

Property Value

string

The schema name. Defaults to "dbo".

TableName

Gets or sets the name of the database table used for storing dead letter entries.

public string TableName { get; set; }

Property Value

string

The table name for dead letter entries. Defaults to "DeadLetterQueue".