Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

PostgresServerResource.AddDatabase

Method
📦 Aspire.Hosting.PostgreSQL v17.0.0
type PostgresServerResource interface {
// ... omitted for brevity
AddDatabase(
name string,
options ...*AddDatabaseOptions,
) PostgresDatabaseResource
}

Signature

methodAddDatabasebuilder
Adds a PostgreSQL database to the application model.
AddDatabase(
name string,
options ...*AddDatabaseOptions,
) PostgresDatabaseResource
namestringThe name of the resource. This name will be used as the connection string name when referenced in a dependency.
options...*AddDatabaseOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*AddDatabaseOptions argument.

DatabaseName*stringThe name of the database. If not provided, this defaults to the same value as name.
PostgresDatabaseResource

The resource builder.

Returns a handle; failures surface later via Err().

Defined on

This method is defined on the following type: