Edit

Share via

.NET Aspire Community Toolkit SQL Server hosting extensions

Includes: Hosting integration included Hosting integration only — Client integration not included Client integration not included

Note

This integration is part of the .NET Aspire Community Toolkit and isn't officially supported by the .NET Aspire team.

In this article, you learn about the .NET Aspire Community Toolkit SQL Server hosting extensions package which provides extra functionality to the .NET Aspire SQL Server hosting package.

This package provides the following features:

Hosting integration

To get started with the .NET Aspire Community Toolkit SQL Server hosting extensions, install the 📦 CommunityToolkit.Aspire.Hosting.SqlServer.Extensions NuGet package in the AppHost project.

dotnet add package CommunityToolkit.Aspire.Hosting.SqlServer.Extensions

For more information, see dotnet add package or Manage package dependencies in .NET applications.

Example usage

To add the DbGate management UI to your SQL Server resource, call the WithDbGate method on the SqlServerResourceBuilder instance.

var sqlserver = builder.AddSqlServer("sqlserver")
    .WithDbGate();

To add the Adminer management UI to your SQL Server resource, call the WithAdminer method on the SqlServerResourceBuilder instance.

var sqlserver = builder.AddSqlServer("sqlserver")
    .WithAdminer();

This will add a new resource to the app host which will be available from the .NET Aspire dashboard.