Aspire.Hosting.PostgreSQL

Docs / Reference / Search TypeScript APIs / Aspire.Hosting.PostgreSQL

Aspire.Hosting.PostgreSQL

Docs Reference Search TypeScript APIs Aspire.Hosting.PostgreSQL

Official

📦 Aspire.Hosting.PostgreSQL v13.2.0-preview.1.26159.1

14 Functions

5 Types

Search types, functions, members in Aspire.Hosting.PostgreSQL...

function handle method property

5 types and 32 members Clear filters

Types

handle PgAdminContainerResource 1 members

handle PgWebContainerResource 1 members

handle PostgresDatabaseResource 8 members

handle PostgresMcpContainerResource

handle PostgresServerResource 22 members

Functions

function addDatabase builder

Adds a PostgreSQL database

addDatabase(name: string, databaseName?: string): PostgresDatabaseResource

function addPostgres builder

Adds a PostgreSQL server resource

addPostgres(name: string, userName?: ParameterResource, password?: ParameterResource, port?: number): PostgresServerResource

function withCreationScript builder

Defines the SQL script for database creation

withCreationScript(script: string): PostgresDatabaseResource

function withDataBindMount builder

Adds a data bind mount for PostgreSQL

withDataBindMount(source: string, isReadOnly?: boolean): PostgresServerResource

function withDataVolume builder

Adds a data volume for PostgreSQL

withDataVolume(name?: string, isReadOnly?: boolean): PostgresServerResource

function withHostPort builder

Sets the host port for pgAdmin

withHostPort(port: number): PgAdminContainerResource

function withHostPort builder

Sets the host port for pgweb

withHostPort(port: number): PgWebContainerResource

function withHostPort builder

Sets the host port for PostgreSQL

withHostPort(port: number): PostgresServerResource

function withInitFiles builder

Copies init files to PostgreSQL

withInitFiles(source: string): PostgresServerResource

function withPassword builder

Configures the PostgreSQL password

withPassword(password: ParameterResource): PostgresServerResource

function withPgAdmin builder

Adds pgAdmin 4 management UI

withPgAdmin(configureContainer?: (obj: PgAdminContainerResource) => void, containerName?: string): PostgresServerResource

function withPgWeb builder

Adds pgweb management UI

withPgWeb(configureContainer?: (obj: PgWebContainerResource) => void, containerName?: string): PostgresServerResource

function withPostgresMcp builder

Adds Postgres MCP server

withPostgresMcp(configureContainer?: (obj: PostgresMcpContainerResource) => void, containerName?: string): PostgresDatabaseResource

function withUserName builder

Configures the PostgreSQL user name

withUserName(userName: ParameterResource): PostgresServerResource