Getting Started

SQL Azure

Target Version: NServiceBus 9.x

NHibernate persistence works with SQL Azure without needing to make any changes to code or configuration. However, there are considerations that should be taken into account when using a remote database.

Relational database as a service

When using a relational database as a service for persisting NServiceBus data, it is important to keep in mind that this type of data store has different runtime semantics than a traditional relational database.

  • The data store is potentially located in a remote location and is thus subject to a broad range of potential networking issues.
  • 'As a service' environments such as SQL Azure are typically shared environments, so performance of the database can be impacted by the behavior of other databases on the server.

The combination of these characteristics means that any transaction executed against the database may show intermittent exceptions. Usually these exceptions are transient in nature and can be resolved by retrying the transaction. A good place to start is the Transient Fault Handling documentation from Microsoft.

NHibernate specifics

As these exceptions can occur anywhere, they are best dealt with at the generic infrastructure level, using an NHibernate driver.

The NHibernate community has created a driver specific for SQL Azure called NHibernate.SqlAzure. This driver leverages the Microsoft Transient Fault Handling library to ensure reliable SQL Azure connections.

NuGet packages

There are two choices of package for this library.


After installation of the package, enable the driver by setting the NHibernate connection.driver_class property:

var nhConfiguration = new Configuration
    Properties =
        ["connection.driver_class"] = "NHibernate.SqlAzure.SqlAzureClientDriver, NHibernate.SqlAzure"

var persistence = endpointConfiguration.UsePersistence<NHibernatePersistence>();

Related Articles