Getting Started

SQL Persistence - SQL Server dialect

Component: Sql Persistence
Target Version: NServiceBus 7.x

Supported database versions

SQL persistence supports SQL Server Version 2012. It does not work with lower versions due to the use of the THROW functionality.


Using either the System.Data.SqlClient or Microsoft.Data.SqlClient NuGet packages.

var connection = @"Data Source=.\SqlExpress;Initial Catalog=dbname;Integrated Security=True";
var persistence = endpointConfiguration.UsePersistence<SqlPersistence>();
var subscriptions = persistence.SubscriptionSettings();
    connectionBuilder: () =>
        return new SqlConnection(connection);


Microsoft Entra authentication is supported via the standard connection string options.

Unicode support

SQL persistence itself supports Unicode characters, however data may become corrupted during saving if the database settings are incorrect. If Unicode support is required, follow the guidelines for each database engine. In particular set the correct character set and collation for databases storing persistence data.

Refer to the dedicated SQL Server documentation for details.

Supported name lengths

SQL persistence automatically generates names of database objects such as tables, indexes and procedures used internally. Every database engine has its own rules and limitations regarding maximum allowed name length.

SQL Server supports max. 128 characters.

Schema support

The SQL Server dialect supports multiple schemas. By default, when a schema is not specified, it uses the dbo schema when referring to database objects.

var persistence = endpointConfiguration.UsePersistence<SqlPersistence>();
var dialect = persistence.SqlDialect<SqlDialect.MsSqlServer>();

SQL Always Encrypted

The SQL Server dialect has support for SQL Server Always Encrypted.

The steps to use SQL Always Encrypted are:

  1. Make sure SQL Always Encrypted is configured with the correct certificate or key stores on the database engine and the client machines.
  2. Encrypt the Body column for the saga table that encryption is being enabled for. For more information on how to encrypt columns in SQL Server, refer to the Microsoft documentation.
  3. Encrypt the Operations column for the OutboxData table. This contains business data in the form of outgoing messages. There is a separate OutboxData table for every endpoint that uses the outbox feature.
  4. Ensure the connection string for the endpoint includes the Column Encryption Setting = Enabled; connection string parameter.

The Body and Operations columns will now be readable only by clients that have the correct certificate or key stores configured.