Add option to Starter template to include a database with EF Core and migrations

[AndriySvyryd]

Based on https://github.com/dotnet/aspire-samples/tree/main/samples/DatabaseMigrations/DatabaseMigrations.MigrationService with placeholders for provider-specific code

[DamianEdwards]

There's also the web-based example we have at https://github.com/dotnet/aspire-samples/tree/main/samples/AspireShop/AspireShop.CatalogDbManager

[davidfowl]

I think we should consider another sample template that's crud + EF + postgres, showing how to use migrations etc.

[DamianEdwards]

Or we could just add it to the existing starter template, potentially as an option.

[DamianEdwards]

Strawman with some open questions:

We get a lot of feedback about what patterns work well to configure, initialize, and manage a database using EF Core as part of an Aspire app. We have some samples and documentation on this but we should take this guidance to the next level and include it in our starter template.

Rough idea of what this would include:

• A new option on the template to include a database that allows selecting between the supported database integrations: PostgreSQL, MS SQL Server, MySQL, MongoDB, or Oracle
  • ❓ Should we limit this to just PostgreSQL and MS SQL Server? Some other combo?
• A simple page in the Blazor app that uses the database and demonstrates basic CRUD, e.g. a Todo's list
• A new API in the API project that exposes an HTTP API for the data in the database (this aligns with the webapiaot template so we can lift the relevant implementation from there)
  • ❓ Should this be a new API added in the existing project or should we separate into its own API project?
• A new worker service project to own and run the migrations based on the existing sample
• Relevant code in the AppHost project to add the database server and instance resources, the new worker service project, and configure the API & worker service projects to reference the database resource and WaitFor it
• Update the tests project to add a test that hits the page that depends on the database

[davidfowl]

❓ Should we limit this to just PostgreSQL and MS SQL Server? Some other combo?

1. PostgreSQL, MS SQL Server

A new API in the API project that exposes an HTTP API for the data in the database (this aligns with the webapiaot template so we can lift the relevant implementation from there)

Yes, we should do the DB stuff in existing API not from the front end directly.