Code snippet for adding Postgres to an Aspire project is broken

[manio143]

Type of issue

Code doesn't work

Description

In Add PostgreSQL server resource section there's a reference to this code:

var postgres = builder.AddPostgres("postgres");
var postgresdb = postgres.AddDatabase("postgresdb");

Unless you use EF Core with database creation on launch, this example will not work out of the box. For example, I'm using Marten and I'm getting an error back that Database postgresdb doesn't exist. See dotnet/aspire#1170 for more context.

IMO, the default sample in the docs should provide code that works out of the box, without depending on other libraries the user may or may not choose to use. At the very least, there should be a warning section added to the article which mentions that the database will not be created.

Page URL

https://learn.microsoft.com/en-us/dotnet/aspire/database/postgresql-integration?tabs=dotnet-cli

Content source URL

https://github.com/dotnet/docs-aspire/blob/main/docs/database/postgresql-integration.md

Document Version Independent Id

7e347326-fccf-e227-1509-b45fbfe94ba3

Article author

@CamSoper