CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects 9.5.0-beta.295

Prefix Reserved
This is a prerelease version of CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects.
There is a newer version of this package available.
See the version list below for details.
dotnet add package CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects --version 9.5.0-beta.295
                    
NuGet\Install-Package CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects -Version 9.5.0-beta.295
                    
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="CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects" Version="9.5.0-beta.295" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects" Version="9.5.0-beta.295" />
                    
Directory.Packages.props
<PackageReference Include="CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects" />
                    
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 CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects --version 9.5.0-beta.295
                    
#r "nuget: CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects, 9.5.0-beta.295"
                    
#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.
#addin nuget:?package=CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects&version=9.5.0-beta.295&prerelease
                    
Install CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects as a Cake Addin
#tool nuget:?package=CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects&version=9.5.0-beta.295&prerelease
                    
Install CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects as a Cake Tool

CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects library

This package provides .NET Aspire integration for SQL Server Database Projects. It allows you to publish SQL Database Projects as part of your .NET Aspire AppHost projects. It currently works with both MSBuild.Sdk.SqlProj and Microsoft.Build.Sql (aka .sqlprojx) based projects.

Usage

To use this package, install it into your .NET Aspire AppHost project:

dotnet add package CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects

Next, add a reference to the MSBuild.Sdk.SqlProj or Microsoft.Build.Sql project you want to publish in your .NET Aspire AppHost project:

dotnet add reference ../MySqlProj/MySqlProj.csproj

Note: Adding this reference will currently result in warning ASPIRE004. This is a known issue and will be resolved in a future release.

Finally add the project as a resource to your .NET Aspire AppHost:

var builder = DistributedApplication.CreateBuilder(args);

var sql = builder.AddSqlServer("sql")
                 .AddDatabase("test");

builder.AddSqlProject<Projects.MySqlProj>("mysqlproj")
       .WithReference(sql);

builder.Build().Run();

Now when you run your .NET Aspire AppHost project you will see the SQL Database Project being published to the specified SQL Server.

Local .dacpac file support

If you are sourcing your .dacpac file from somewhere other than a project reference, you can also specify the path to the .dacpac file directly:

var builder = DistributedApplication.CreateBuilder(args);

var sql = builder.AddSqlServer("sql")
                 .AddDatabase("test");

builder.AddSqlProject("mysqlproj")
       .WithDacpac("path/to/mysqlproj.dacpac")
       .WithReference(sql);

builder.Build().Run();

Support for existing SQL Server

Instead of using the AddSqlServer method to use a SQL Server container, you can specify a connection string to an existing server:

var builder = DistributedApplication.CreateBuilder(args);

// Get an existing connection string from the configuration
var connection = builder.AddConnectionString("Aspire");

builder.AddSqlProject<Projects.SdkProject>("mysqlproj")
       .WithReference(connection);

builder.Build().Run();

Deployment options support

Define options that affect the behavior of package deployment.

var builder = DistributedApplication.CreateBuilder(args);

var sql = builder.AddSqlServer("sql")
                 .AddDatabase("test");

builder.AddSqlProject("mysqlproj")
       .WithConfigureDacDeployOptions(options => options.IncludeCompositeObjects = true)
       .WithReference(sql);

builder.Build().Run();
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  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.

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
9.5.1-beta.300 0 5/28/2025
9.5.0 47 5/27/2025
9.5.0-beta.299 27 5/27/2025
9.5.0-beta.298 33 5/26/2025
9.5.0-beta.297 36 5/24/2025
9.5.0-beta.296 32 5/24/2025
9.5.0-beta.295 34 5/24/2025
9.4.1-beta.291 106 5/19/2025
9.4.1-beta.289 115 5/16/2025
9.4.1-beta.288 171 5/16/2025
9.4.1-beta.287 167 5/16/2025
9.4.1-beta.286 167 5/16/2025
9.4.1-beta.285 186 5/14/2025
9.4.1-beta.284 190 5/13/2025
9.4.1-beta.283 197 5/12/2025
9.4.1-beta.282 111 5/7/2025
9.4.1-beta.280 111 5/2/2025
9.4.1-beta.279 106 5/2/2025
9.4.1-beta.277 123 4/23/2025
9.4.1-beta.276 119 4/23/2025
9.4.1-beta.275 123 4/23/2025
9.4.1-beta.274 123 4/23/2025
9.4.1-beta.273 116 4/23/2025
9.4.1-beta.272 120 4/23/2025
9.4.1-beta.271 117 4/23/2025
9.4.1-beta.270 123 4/20/2025
9.4.0 1,600 4/20/2025
9.4.0-beta.269 124 4/20/2025
9.4.0-beta.268 118 4/20/2025
9.3.1-beta.267 122 4/20/2025
9.3.1-beta.266 51 4/19/2025
9.3.1-beta.265 237 4/15/2025
9.3.1-beta.264 150 4/15/2025
9.3.1-beta.263 148 4/15/2025
9.3.1-beta.262 152 4/15/2025
9.3.1-beta.260 134 4/10/2025
9.3.1-beta.259 633 4/8/2025
9.3.1-beta.258 119 4/8/2025
9.3.1-beta.257 119 4/8/2025
9.3.1-beta.256 121 4/8/2025
9.3.1-beta.255 122 4/8/2025
9.3.1-beta.254 121 4/8/2025
9.3.1-beta.253 128 4/1/2025
9.3.1-beta.252 368 3/27/2025
9.3.1-beta.250 99 3/27/2025
9.3.1-beta.249 96 3/27/2025
9.3.1-beta.248 100 3/27/2025
9.3.1-beta.247 104 3/27/2025
9.3.1-beta.244 445 3/25/2025
9.3.1-beta.242 441 3/24/2025
9.3.1-beta.241 121 3/19/2025
9.3.0 3,291 3/19/2025
9.3.0-beta.239 112 3/19/2025
9.2.2-beta.237 112 3/19/2025
9.2.2-beta.236 86 3/14/2025
9.2.2-beta.230 118 3/13/2025
9.2.2-beta.229 110 3/13/2025
9.2.2-beta.228 133 3/11/2025
9.2.2-beta.227 117 3/11/2025
9.2.2-beta.226 127 3/11/2025
9.2.2-beta.225 115 3/11/2025
9.2.2-beta.224 120 3/11/2025
9.2.2-beta.223 129 3/10/2025
9.2.2-beta.222 134 3/10/2025
9.2.2-beta.220 123 3/9/2025
9.2.2-beta.218 125 3/9/2025
9.2.2-beta.217 169 3/7/2025
9.2.2-beta.216 167 3/7/2025
9.2.2-beta.215 168 3/7/2025
9.2.2-beta.214 165 3/5/2025
9.2.2-beta.213 159 3/5/2025
9.2.2-beta.212 156 3/5/2025
9.2.2-beta.211 167 3/4/2025
9.2.2-beta.210 162 3/4/2025
9.2.2-beta.208 64 3/3/2025
9.2.1 1,392 3/3/2025
9.2.1-beta.207 95 3/2/2025
9.2.1-beta.206 56 3/1/2025
9.2.1-beta.205 58 2/27/2025
9.2.1-beta.204 58 2/26/2025
9.2.1-beta.203 52 2/26/2025
9.2.0 797 2/26/2025
9.2.0-beta.202 56 2/26/2025
9.2.0-beta.201 58 2/26/2025
9.2.0-beta.199 52 2/26/2025
9.2.0-beta.198 47 2/26/2025
9.1.1-beta.197 69 2/25/2025
9.1.1-beta.196 54 2/25/2025
9.1.1-beta.195 56 2/25/2025
9.1.1-beta.194 54 2/25/2025
9.1.1-beta.193 51 2/25/2025
9.1.1-beta.192 58 2/24/2025
9.1.1-beta.191 67 2/24/2025
9.1.1-beta.190 63 2/19/2025
9.1.1-beta.189 59 2/19/2025
9.1.1-beta.188 61 2/19/2025
9.1.1-beta.187 66 2/19/2025
9.1.1-beta.183 69 2/18/2025
9.1.1-beta.182 68 2/18/2025
9.1.1-beta.181 75 2/18/2025
9.1.1-beta.180 61 2/17/2025
9.1.1-beta.178 54 2/17/2025
9.1.1-beta.177 72 2/12/2025
9.1.1-beta.176 83 2/11/2025
9.1.1-beta.175 71 2/11/2025
9.1.1-beta.173 70 2/10/2025
9.1.1-beta.169 61 2/6/2025
9.1.1-beta.168 56 2/5/2025
9.1.1-beta.166 114 2/5/2025
9.1.1-beta.165 51 2/5/2025
9.1.1-beta.164 62 2/3/2025
9.1.1-beta.162 58 2/3/2025
9.1.1-beta.155 57 1/30/2025
9.1.1-beta.154 60 1/30/2025
9.1.1-beta.153 53 1/30/2025
9.1.1-beta.152 51 1/29/2025
9.1.1-beta.150 62 1/29/2025
9.1.1-beta.148 64 1/26/2025
9.1.1-beta.147 53 1/26/2025
9.1.1-beta.146 56 1/23/2025
9.1.1-beta.145 52 1/22/2025
9.1.1-beta.144 51 1/22/2025
9.1.1-beta.142 50 1/22/2025
9.1.1-beta.140 51 1/22/2025
9.1.1-beta.139 53 1/21/2025
9.1.1-beta.138 48 1/20/2025
9.1.1-beta.137 49 1/17/2025
9.1.1-beta.136 50 1/15/2025
9.1.1-beta.135 24 1/15/2025
9.1.1-beta.134 23 1/15/2025
9.1.1-beta.128 41 1/9/2025
9.1.1-beta.127 39 1/9/2025
9.1.1-beta.126 47 1/9/2025
9.1.1-beta.125 54 1/9/2025
9.1.1-beta.124 46 1/9/2025
9.1.0 2,767 12/12/2024
9.1.0-beta.123 62 1/3/2025
9.1.0-beta.122 68 1/3/2025
9.1.0-beta.121 58 1/2/2025
9.1.0-beta.120 57 12/30/2024
9.1.0-beta.119 53 12/30/2024
9.1.0-beta.118 56 12/30/2024
9.1.0-beta.116 57 12/30/2024
9.1.0-beta.114 55 12/30/2024
9.1.0-beta.113 54 12/30/2024
9.1.0-beta.112 54 12/18/2024
9.1.0-beta.110 60 12/16/2024
9.1.0-beta.109 54 12/12/2024
9.0.1-beta.108 64 12/12/2024
9.0.1-beta.107 59 12/11/2024
9.0.1-beta.106 58 12/12/2024
9.0.1-beta.104 58 12/11/2024
9.0.1-beta.102 58 12/6/2024
9.0.1-beta.99 60 12/6/2024
9.0.1-beta.98 56 12/6/2024
9.0.1-beta.95 60 12/5/2024
9.0.1-beta.94 59 12/5/2024
9.0.1-beta.93 54 12/2/2024
9.0.1-beta.92 155 11/30/2024
9.0.1-beta.91 50 11/30/2024
9.0.1-beta.90 58 11/29/2024
9.0.1-beta.89 58 11/29/2024
9.0.1-beta.88 57 11/27/2024
9.0.1-beta.87 49 11/27/2024
9.0.1-beta.86 57 11/27/2024
9.0.1-beta.84 61 11/24/2024
9.0.1-beta.83 60 11/22/2024
9.0.1-beta.82 61 11/21/2024
9.0.1-beta.81 51 11/19/2024
9.0.1-beta.80 45 11/19/2024
9.0.1-beta.79 52 11/19/2024
9.0.1-beta.77 52 11/15/2024
9.0.0 652 11/15/2024
9.0.0-beta.76 55 11/14/2024
9.0.0-beta.75 53 11/14/2024
9.0.0-beta.74 55 11/14/2024
9.0.0-beta.73 183 11/14/2024
9.0.0-beta.72 53 11/14/2024
9.0.0-beta.71 56 11/13/2024
9.0.0-beta.70 110 11/13/2024
9.0.0-beta.69 60 11/13/2024
9.0.0-beta.68 60 11/13/2024
9.0.0-beta.67 55 11/13/2024
9.0.0-beta.66 92 11/13/2024
9.0.0-beta.63 65 11/12/2024