CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects 9.5.0

Prefix Reserved
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects --version 9.5.0
                    
NuGet\Install-Package CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects -Version 9.5.0
                    
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" />
                    
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" />
                    
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
                    
#r "nuget: CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects, 9.5.0"
                    
#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
                    
Install as a Cake Addin
#tool nuget:?package=CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects&version=9.5.0
                    
Install 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.318 106 7/2/2025
9.5.1-beta.317 98 6/30/2025
9.5.1-beta.315 106 6/26/2025
9.5.1-beta.314 106 6/23/2025
9.5.1-beta.313 95 6/20/2025
9.5.1-beta.312 100 6/20/2025
9.5.1-beta.311 109 6/18/2025
9.5.1-beta.310 110 6/17/2025
9.5.1-beta.309 104 6/17/2025
9.5.1-beta.308 111 6/17/2025
9.5.1-beta.307 109 6/16/2025
9.5.1-beta.306 261 6/11/2025
9.5.1-beta.305 91 6/7/2025
9.5.1-beta.304 99 6/6/2025
9.5.1-beta.303 120 6/4/2025
9.5.1-beta.302 114 6/4/2025
9.5.1-beta.301 117 6/2/2025
9.5.1-beta.300 122 5/28/2025
9.5.0 1,953 5/27/2025
9.5.0-beta.299 114 5/27/2025
9.5.0-beta.298 123 5/26/2025
9.5.0-beta.297 72 5/24/2025
9.5.0-beta.296 67 5/24/2025
9.5.0-beta.295 48 5/24/2025
9.4.1-beta.291 117 5/19/2025
9.4.1-beta.289 130 5/16/2025
9.4.1-beta.288 180 5/16/2025
9.4.1-beta.287 176 5/16/2025
9.4.1-beta.286 181 5/16/2025
9.4.1-beta.285 194 5/14/2025
9.4.1-beta.284 196 5/13/2025
9.4.1-beta.283 203 5/12/2025
9.4.1-beta.282 119 5/7/2025
9.4.1-beta.280 123 5/2/2025
9.4.1-beta.279 118 5/2/2025
9.4.1-beta.277 128 4/23/2025
9.4.1-beta.276 129 4/23/2025
9.4.1-beta.275 129 4/23/2025
9.4.1-beta.274 132 4/23/2025
9.4.1-beta.273 124 4/23/2025
9.4.1-beta.272 131 4/23/2025
9.4.1-beta.271 124 4/23/2025
9.4.1-beta.270 132 4/20/2025
9.4.0 2,627 4/20/2025
9.4.0-beta.269 130 4/20/2025
9.4.0-beta.268 122 4/20/2025
9.3.1-beta.267 128 4/20/2025
9.3.1-beta.266 60 4/19/2025
9.3.1-beta.265 263 4/15/2025
9.3.1-beta.264 156 4/15/2025
9.3.1-beta.263 159 4/15/2025
9.3.1-beta.262 162 4/15/2025
9.3.1-beta.260 142 4/10/2025
9.3.1-beta.259 960 4/8/2025
9.3.1-beta.258 136 4/8/2025
9.3.1-beta.257 131 4/8/2025
9.3.1-beta.256 135 4/8/2025
9.3.1-beta.255 128 4/8/2025
9.3.1-beta.254 131 4/8/2025
9.3.1-beta.253 139 4/1/2025
9.3.1-beta.252 376 3/27/2025
9.3.1-beta.250 106 3/27/2025
9.3.1-beta.249 104 3/27/2025
9.3.1-beta.248 107 3/27/2025
9.3.1-beta.247 111 3/27/2025
9.3.1-beta.244 454 3/25/2025
9.3.1-beta.242 449 3/24/2025
9.3.1-beta.241 130 3/19/2025
9.3.0 4,653 3/19/2025
9.3.0-beta.239 118 3/19/2025
9.2.2-beta.237 125 3/19/2025
9.2.2-beta.236 96 3/14/2025
9.2.2-beta.230 130 3/13/2025
9.2.2-beta.229 123 3/13/2025
9.2.2-beta.228 143 3/11/2025
9.2.2-beta.227 127 3/11/2025
9.2.2-beta.226 136 3/11/2025
9.2.2-beta.225 122 3/11/2025
9.2.2-beta.224 127 3/11/2025
9.2.2-beta.223 138 3/10/2025
9.2.2-beta.222 141 3/10/2025
9.2.2-beta.220 133 3/9/2025
9.2.2-beta.218 132 3/9/2025
9.2.2-beta.217 177 3/7/2025
9.2.2-beta.216 174 3/7/2025
9.2.2-beta.215 174 3/7/2025
9.2.2-beta.214 170 3/5/2025
9.2.2-beta.213 166 3/5/2025
9.2.2-beta.212 165 3/5/2025
9.2.2-beta.211 172 3/4/2025
9.2.2-beta.210 171 3/4/2025
9.2.2-beta.208 71 3/3/2025
9.2.1 1,415 3/3/2025
9.2.1-beta.207 104 3/2/2025
9.2.1-beta.206 63 3/1/2025
9.2.1-beta.205 67 2/27/2025
9.2.1-beta.204 71 2/26/2025
9.2.1-beta.203 61 2/26/2025
9.2.0 833 2/26/2025
9.2.0-beta.202 64 2/26/2025
9.2.0-beta.201 77 2/26/2025
9.2.0-beta.199 60 2/26/2025
9.2.0-beta.198 56 2/26/2025
9.1.1-beta.197 79 2/25/2025
9.1.1-beta.196 63 2/25/2025
9.1.1-beta.195 68 2/25/2025
9.1.1-beta.194 65 2/25/2025
9.1.1-beta.193 62 2/25/2025
9.1.1-beta.192 66 2/24/2025
9.1.1-beta.191 77 2/24/2025
9.1.1-beta.190 69 2/19/2025
9.1.1-beta.189 72 2/19/2025
9.1.1-beta.188 69 2/19/2025
9.1.1-beta.187 73 2/19/2025
9.1.1-beta.183 81 2/18/2025
9.1.1-beta.182 72 2/18/2025
9.1.1-beta.181 87 2/18/2025
9.1.1-beta.180 72 2/17/2025
9.1.1-beta.178 68 2/17/2025
9.1.1-beta.177 85 2/12/2025
9.1.1-beta.176 88 2/11/2025
9.1.1-beta.175 78 2/11/2025
9.1.1-beta.173 76 2/10/2025
9.1.1-beta.169 72 2/6/2025
9.1.1-beta.168 62 2/5/2025
9.1.1-beta.166 126 2/5/2025
9.1.1-beta.165 58 2/5/2025
9.1.1-beta.164 69 2/3/2025
9.1.1-beta.162 63 2/3/2025
9.1.1-beta.155 64 1/30/2025
9.1.1-beta.154 73 1/30/2025
9.1.1-beta.153 58 1/30/2025
9.1.1-beta.152 57 1/29/2025
9.1.1-beta.150 70 1/29/2025
9.1.1-beta.148 72 1/26/2025
9.1.1-beta.147 63 1/26/2025
9.1.1-beta.146 63 1/23/2025
9.1.1-beta.145 57 1/22/2025
9.1.1-beta.144 59 1/22/2025
9.1.1-beta.142 63 1/22/2025
9.1.1-beta.140 57 1/22/2025
9.1.1-beta.139 65 1/21/2025
9.1.1-beta.138 54 1/20/2025
9.1.1-beta.137 57 1/17/2025
9.1.1-beta.136 57 1/15/2025
9.1.1-beta.135 30 1/15/2025
9.1.1-beta.134 31 1/15/2025
9.1.1-beta.128 51 1/9/2025
9.1.1-beta.127 44 1/9/2025
9.1.1-beta.126 56 1/9/2025
9.1.1-beta.125 70 1/9/2025
9.1.1-beta.124 58 1/9/2025
9.1.0 2,780 12/12/2024
9.1.0-beta.123 72 1/3/2025
9.1.0-beta.122 78 1/3/2025
9.1.0-beta.121 64 1/2/2025
9.1.0-beta.120 67 12/30/2024
9.1.0-beta.119 62 12/30/2024
9.1.0-beta.118 65 12/30/2024
9.1.0-beta.116 66 12/30/2024
9.1.0-beta.114 65 12/30/2024
9.1.0-beta.113 63 12/30/2024
9.1.0-beta.112 61 12/18/2024
9.1.0-beta.110 70 12/16/2024
9.1.0-beta.109 66 12/12/2024
9.0.1-beta.108 77 12/12/2024
9.0.1-beta.107 68 12/11/2024
9.0.1-beta.106 66 12/12/2024
9.0.1-beta.104 67 12/11/2024
9.0.1-beta.102 64 12/6/2024
9.0.1-beta.99 68 12/6/2024
9.0.1-beta.98 61 12/6/2024
9.0.1-beta.95 68 12/5/2024
9.0.1-beta.94 64 12/5/2024
9.0.1-beta.93 61 12/2/2024
9.0.1-beta.92 159 11/30/2024
9.0.1-beta.91 65 11/30/2024
9.0.1-beta.90 66 11/29/2024
9.0.1-beta.89 70 11/29/2024
9.0.1-beta.88 66 11/27/2024
9.0.1-beta.87 61 11/27/2024
9.0.1-beta.86 68 11/27/2024
9.0.1-beta.84 74 11/24/2024
9.0.1-beta.83 67 11/22/2024
9.0.1-beta.82 72 11/21/2024
9.0.1-beta.81 60 11/19/2024
9.0.1-beta.80 54 11/19/2024
9.0.1-beta.79 64 11/19/2024
9.0.1-beta.77 63 11/15/2024
9.0.0 668 11/15/2024
9.0.0-beta.76 66 11/14/2024
9.0.0-beta.75 67 11/14/2024
9.0.0-beta.74 65 11/14/2024
9.0.0-beta.73 190 11/14/2024
9.0.0-beta.72 58 11/14/2024
9.0.0-beta.71 62 11/13/2024
9.0.0-beta.70 121 11/13/2024
9.0.0-beta.69 70 11/13/2024
9.0.0-beta.68 70 11/13/2024
9.0.0-beta.67 58 11/13/2024
9.0.0-beta.66 104 11/13/2024
9.0.0-beta.63 73 11/12/2024