PostgresBuilderExtensions
Classstaticnet10.0
Provides extension methods for adding PostgreSQL resources to an
Hosting.IDistributedApplicationBuilder. namespace Aspire.Hosting;
public static class PostgresBuilderExtensions{ // ...}16 members
Methods16
Section titled MethodsIResourceBuilder<PostgresDatabaseResource> Adds a PostgreSQL database to the application model.
AddPostgres(IDistributedApplicationBuilder, string, IResourceBuilder<ParameterResource>, IResourceBuilder<ParameterResource>, int?)extensionats exportIResourceBuilder<PostgresServerResource> Adds a PostgreSQL resource to the application model. A container is used for local development.
IResourceBuilder<PostgresDatabaseResource> Defines the SQL script used to create the database.
IResourceBuilder<PostgresServerResource> Adds a bind mount for the data folder to a PostgreSQL container resource.
IResourceBuilder<PostgresServerResource> Adds a named volume for the data folder to a PostgreSQL container resource.
IResourceBuilder<PgAdminContainerResource> Configures the host port that the PGAdmin resource is exposed on instead of using randomly assigned port.
IResourceBuilder<PgWebContainerResource> Configures the host port that the pgweb resource is exposed on instead of using randomly assigned port.
IResourceBuilder<PostgresServerResource> Configures the host port that the PostgreSQL resource is exposed on instead of using randomly assigned port.
WithInitBindMount(IResourceBuilder<PostgresServerResource>, string, bool)extensionobsoleteats ignoredIResourceBuilder<PostgresServerResource> Adds a bind mount for the init folder to a PostgreSQL container resource.
IResourceBuilder<PostgresServerResource> Copies init files to a PostgreSQL container resource.
WithPassword(IResourceBuilder<PostgresServerResource>, IResourceBuilder<ParameterResource>)extensionats exportIResourceBuilder<PostgresServerResource> Configures the password that the PostgreSQL resource is used.
WithPgAdmin(IResourceBuilder<T>, Action<IResourceBuilder<PgAdminContainerResource>>, string?)extensionats exportIResourceBuilder<T> Adds a pgAdmin 4 administration and development platform for PostgreSQL to the application model.
WithPgWeb(IResourceBuilder<PostgresServerResource>, Action<IResourceBuilder<PgWebContainerResource>>, string?)extensionats exportIResourceBuilder<PostgresServerResource> Adds an administration and development platform for PostgreSQL to the application model using pgweb.
WithPostgresMcp(IResourceBuilder<PostgresDatabaseResource>, Action<IResourceBuilder<PostgresMcpContainerResource>>, string?)extensionexperimentalats exportIResourceBuilder<PostgresDatabaseResource> Adds a Postgres MCP server container and configures it to connect to the database represented by
builder. IResourceBuilder<PostgresServerResource> Adds a REPL command that opens an authenticated PostgreSQL shell in the dashboard terminal dock.
WithUserName(IResourceBuilder<PostgresServerResource>, IResourceBuilder<ParameterResource>)extensionats exportIResourceBuilder<PostgresServerResource> Configures the user name that the PostgreSQL resource is used.
Aspire