Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

AddPostgres

Method
📦 Aspire.Hosting.PostgreSQL v17.0.0
func (DistributedApplicationBuilder) AddPostgres(
name string,
options ...*AddPostgresOptions,
) PostgresServerResource

Signature

methodAddPostgresbuilder
Adds a PostgreSQL resource to the application model. A container is used for local development.
AddPostgres(
name string,
options ...*AddPostgresOptions,
) PostgresServerResource
namestringThe name of the resource. This name will be used as the connection string name when referenced in a dependency.
options...*AddPostgresOptionsOptional settings, described under Options.

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

UserName*ParameterResourceThe parameter used to provide the user name for the PostgreSQL resource. If null a default value will be used.
Password*ParameterResourceThe parameter used to provide the administrator password for the PostgreSQL resource. If null a random password will be generated.
Port*float64The host port used when launching the container. If null a random port will be assigned.
PostgresServerResource

The resource builder.

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

Applies to

This method applies to the following types:

typeDistributedApplicationBuilder