Compatibility of SqlDatabaseProjects with Aspire.Hosting.Azure.Sql

[dgee2]

Related to an existing integration?

Yes

Existing integration

SqlDatabaseProjects

Overview

You currently cannot pass a database created with AddAzureSqlServer as a reference when calling AddSqlProject.

The proposal is to add functionality so that there is the ability to deploy dacpac style projects to both SQL containers and Azure SQL.

Usage example

var builder = DistributedApplication.CreateBuilder(args);

builder.AddRedis("cache");

var sql = builder.AddAzureSqlServer("sql")
                 .AddDatabase("menu");

var menuDB = builder.AddSqlProject<Projects.MenuDB>("menuDB")
    .WithReference(sql);

Breaking change?

No

Alternatives

Potentially could be a separate package although adding to SqlDatabaseProjects is likely to be a smoother experience for consumers.

Additional context

No response

Help us help you

Yes, but only if others can assist

[Alirexaa]

@ErikEJ @jmezach

[ErikEJ]

I have just added the ability to use a connection string - but not sure what the purpose of AddAzureSqlServer is.

The SQL projects extension is local only, not for deployment manifest.

[ErikEJ]

I think it will work because of the added connection string support, as a AzureSqlServerResource implements IResourceWithConnectionString

[aaronpowell]

I think that adding that package breaks even if you do a local container by doing:

builder.AddAzureSqlServer("sql").RunAsContainer();

I noticed something last week but I had to pivot off Azure to unblock and I haven't gotten back to investigating if it was the integration or my code.

[davidfowl]

What breaks?

[aaronpowell]

the dbproject didn't get deployed

[ErikEJ]

I assume because the extension extends only SqlServerResource and not AzureSqlServerResource?

[jmezach]

Doesn't AzureSqlServerResource extend SqlServerResource?

[ErikEJ]

@jmezach No, I think SqlServerResource is very much a container resource: https://learn.microsoft.com/en-us/dotnet/api/aspire.hosting.azure.azuresqlserverresource?view=dotnet-aspire-8.0

[davidfowl]

We haven't attempted to make this more abstract as yet.

[ErikEJ]

@davidfowl @jmezach Guess we could just add more extension methods that accepts a AzureSqlServerResource and constrain on that in addition to SqlServerResource? If the ability to publish a .dacpac to an Azure SQL DB adds value? (I think it does)

[github-actions]

We have noticed this issue has not been updated within 21 days. If there is no action on this issue in the next 14 days, we will automatically close it. You can use /stale-extend to extend the window.

[dgee2]

@davidfowl @jmezach I'm happy to take a look at implementing @ErikEJ suggestion of adding extension methods if it's agreed that that is the solution to move forward with

[ErikEJ]

@dgee2 Feel free to create a PR, we now have another "customer report"