PostgresDatabaseResource

Handle

📦 Aspire.Hosting.PostgreSQL v13.6.0

interface PostgresDatabaseResource
  extends IExpressionValue,
    IManifestExpressionProvider,
    IResource,
    IResourceWithConnectionString,
    IResourceWithParent,
    PostgresServerResource]],
    IValueProvider,
    IValueWithReferences {
  readonly connectionStringExpression: ReferenceExpression;
  readonly databaseName: string;
  readonly jdbcConnectionString: ReferenceExpression;
  readonly parent: PostgresServerResource;
  readonly uriExpression: ReferenceExpression;
  withCreationScript(script: string): PostgresDatabaseResource;
  withPostgresMcp(configureContainer?: (obj: PostgresMcpContainerResource) => Promise<void>, containerName?: string): PostgresDatabaseResource;
}

7 members

Properties

propertyconnectionStringExpressionReferenceExpressionget

Gets the connection string expression for the Postgres database.

propertydatabaseNamestringget

Gets the database name.

propertyjdbcConnectionStringReferenceExpressionget

Gets the JDBC connection string for the PostgreSQL database.

propertyparentPostgresServerResourceget

Gets the parent PostgresSQL container resource.

propertyuriExpressionReferenceExpressionget

Gets the connection URI expression for the PostgreSQL database.

Methods

methodwithCreationScriptbuilder

Defines the SQL script used to create the database.

withCreationScript(script: string): PostgresDatabaseResource

Parameters

scriptstring

Returns

PostgresDatabaseResource

methodwithPostgresMcpbuilder

Adds a Postgres MCP server container and configures it to connect to the database represented by `builder`.

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

Parameters

configureContainer(obj: PostgresMcpContainerResource) => Promise<void>optional

containerNamestringoptional

Returns

PostgresDatabaseResource