Sql Persistence

NuGet Package NServiceBus.Persistence.Sql (4.x)
Target NServiceBus Version: 7.x

SQL Persistence can store NServiceBus data in different relational database engines, without the need for an intermediate ORM, using only a DbConnection supplied in the configuration.


Supported SQL implementations

NuGet Packages

The SQL Persistence consists of several NuGet Packages.


This packages installs into the MSBuild pipeline and generates all SQL installation scripts at compile time. It does this by interrogating types (in the target assembly) and attributes (from the NServiceBus.Persistence.Sql NuGet package) to infer what scripts to create. It is required for any project where those SQL installation scripts are required. For saga scripts this is any project that contains saga classes. For timeouts, subscriptions and outbox scripts, it is the endpoint hosting project. This package has a dependency on the NServiceBus.Persistence.Sql NuGet package


This package contains several parts

  • APIs for manipulating EndpointConfiguration at configuration time.
  • Runtime implementations of saga, timeouts, subscriptions and outbox persisters.
  • Attribute definitions used to define certain compile time configuration settings. These attributes are then interrogated by the NServiceBus.Persistence.Sql.MsBuild NuGet Package when generating SQL installation scripts
  • Optionally runs SQL installation scripts at endpoint startup for development purposes. See Installer Workflow.


This package contains all APIs that enable the generation of SQL installation scripts using code, i.e. without using the NServiceBus.Persistence.Sql.MsBuild NuGet package.

NServiceBus.Persistence.Sql.ScriptBuilder is currently not ready for general usage. It has been made public, and deployed to NuGet, primarily to enable the generation of documentation in a repeatable way. For example it is used to generate the SQL scripts in the MS SQL Server Scripts, MySql Scripts, Oracle Scripts, and PostgreSQL Scripts pages. In future releases, the API may evolve in ways that do not follow the standard of semantic version. Raise an issue in the NServiceBus.Persistence.Sql repository to discuss this in more detail.

Script creation

SQL installation scripts are created at compile time by the NServiceBus.Persistence.Sql.MsBuild NuGet package. To learn more see Controlling Script Generation.


Related Articles

Last modified