Shuttle.Hopper.SqlServer.Queue 21.0.2

Prefix Reserved

dotnet add package Shuttle.Hopper.SqlServer.Queue --version 21.0.2

NuGet\Install-Package Shuttle.Hopper.SqlServer.Queue -Version 21.0.2

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Shuttle.Hopper.SqlServer.Queue" Version="21.0.2" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Shuttle.Hopper.SqlServer.Queue" Version="21.0.2" />
                    

                            Directory.Packages.props

<PackageReference Include="Shuttle.Hopper.SqlServer.Queue" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add Shuttle.Hopper.SqlServer.Queue --version 21.0.2

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Shuttle.Hopper.SqlServer.Queue, 21.0.2"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package Shuttle.Hopper.SqlServer.Queue@21.0.2

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=Shuttle.Hopper.SqlServer.Queue&version=21.0.2
                    

                            Install as a Cake Addin

#tool nuget:?package=Shuttle.Hopper.SqlServer.Queue&version=21.0.2
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Shuttle.Hopper.SqlServer.Queue

Sql Server implementation of the ITransport interface for use with Shuttle.Hopper. Uses a table for each required queue.

The implementation creates the required tables automatically (via ICreateTransport.CreateAsync). The database user for the endpoint will require permissions to create schemas and tables.

Installation

dotnet add package Shuttle.Hopper.SqlServer.Queue

Supported providers

Currently only the Microsoft.Data.SqlClient provider is supported but this can be extended. You are welcome to create an issue and assistance will be provided where able; else a pull request would be most welcome.

Configuration

The URI structure is sqlserver://configuration-name/queue-name.

services.AddHopper()
    .UseSqlServerQueue(builder =>
    {
        builder.Configure("shuttle", options =>
        {
            options.ConnectionString = "server=.;database=shuttle;user id=sa;password=Pass!000;TrustServerCertificate=true";
            options.Schema = "dbo";
        });
    });

Outbox Support

To enable outbox support for transactional message processing, use the UseOutboxDbContext<TDbContext>() method:

services.AddHopper()
    .UseSqlServerQueue(builder =>
    {
        builder.Configure("shuttle", options => { /* ... */ })
            .UseOutboxDbContext<YourDbContext>();
    });

The default JSON settings structure is as follows:

{
  "Shuttle": {
    "SqlServerQueue": {
      "ConnectionString": "connection-string",
      "Schema": "dbo"
    }
  }
}

Options

Option	Default	Description
`ConnectionString`		The server connection string.
`Schema`	`dbo`	The database schema to use.
`GetOutboxTransactionAsync`	`null`	Optional delegate to obtain an outbox transaction for transactional message processing.

Product	Compatible and additional computed target framework versions.
.NET	net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net10.0
- Microsoft.EntityFrameworkCore.SqlServer (>= 10.0.5)
- Shuttle.Hopper (>= 21.0.2)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
21.0.2	99	4/17/2026
21.0.1	89	4/15/2026
21.0.1-rc4	85	4/12/2026
21.0.1-rc3	85	4/11/2026
21.0.1-rc2	102	3/21/2026
21.0.1-rc1	93	2/28/2026
21.0.1-beta	103	2/7/2026
21.0.0-alpha	104	1/18/2026