SQL Azure

Component: NHibernate Persistence
NuGet Package NServiceBus.NHibernate (8.x)
Target NServiceBus Version: 7.x

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, which means that the performance of the database is impacted by the behavior of neighboring databases.

The combination of these characteristics makes 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. As these exceptions can occur anywhere, they are best dealt with at the generic infrastructure level, using an NHibernate driver.

The NHibernate community has already gone through this exercise and 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 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

Last modified