Aspire.Hosting.PostgreSQL
Official
📦 Aspire.Hosting.PostgreSQL v13.2.0 14 Functions
5 Types
5 types and 23 members
Types
Functions
method
addDatabase builder Adds a PostgreSQL database
addDatabase(name: string, databaseName?: string): PostgresDatabaseResource method
addPostgres builder Adds a PostgreSQL server resource
addPostgres(name: string, userName?: ParameterResource, password?: ParameterResource, port?: number): PostgresServerResource method
withCreationScript builder Defines the SQL script for database creation
withCreationScript(script: string): PostgresDatabaseResource method
withDataBindMount builder Adds a data bind mount for PostgreSQL
withDataBindMount(source: string, isReadOnly?: boolean): PostgresServerResource method
withDataVolume builder Adds a data volume for PostgreSQL
withDataVolume(name?: string, isReadOnly?: boolean): PostgresServerResource method
withHostPort builder Sets the host port for pgAdmin
withHostPort(port: number): PgAdminContainerResource method
withHostPort builder Sets the host port for pgweb
withHostPort(port: number): PgWebContainerResource method
withHostPort builder Sets the host port for PostgreSQL
withHostPort(port: number): PostgresServerResource method
withInitFiles builder Copies init files to PostgreSQL
withInitFiles(source: string): PostgresServerResource method
withPassword builder Configures the PostgreSQL password
withPassword(password: ParameterResource): PostgresServerResource method
withPgAdmin builder Adds pgAdmin 4 management UI
withPgAdmin(configureContainer?: (obj: PgAdminContainerResource) => Promise<void>, containerName?: string): PostgresServerResource method
withPgWeb builder Adds pgweb management UI
withPgWeb(configureContainer?: (obj: PgWebContainerResource) => Promise<void>, containerName?: string): PostgresServerResource method
withPostgresMcp builder Adds Postgres MCP server
withPostgresMcp(configureContainer?: (obj: PostgresMcpContainerResource) => Promise<void>, containerName?: string): PostgresDatabaseResource method
withUserName builder Configures the PostgreSQL user name
withUserName(userName: ParameterResource): PostgresServerResource