PostgresServerResource

Handle

📦 Aspire.Hosting.PostgreSQL v13.6.0

interface PostgresServerResource
  extends IComputeResource,
    IExpressionValue,
    IManifestExpressionProvider,
    IResource,
    IResourceWithArgs,
    IResourceWithConnectionString,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IValueProvider,
    IValueWithReferences {
  readonly connectionStringExpression: ReferenceExpression;
  readonly databases: Dict<string,string>;
  readonly host: EndpointReferenceExpression;
  readonly jdbcConnectionString: ReferenceExpression;
  passwordParameter: ParameterResource;
  readonly port: EndpointReferenceExpression;
  readonly primaryEndpoint: EndpointReference;
  readonly uriExpression: ReferenceExpression;
  userNameParameter: ParameterResource;
  readonly userNameReference: ReferenceExpression;
  addDatabase(
      name: string,
      databaseName?: string): PostgresDatabaseResource;
  withDataBindMount(
      source: string,
      isReadOnly?: boolean): PostgresServerResource;
  withDataVolume(
      name?: string,
      isReadOnly?: boolean): PostgresServerResource;
  withHostPort(port: number): PostgresServerResource;
  withInitFiles(source: string): PostgresServerResource;
  withPassword(password: ParameterResource): PostgresServerResource;
  withPgAdmin(configureContainer?: (obj: PgAdminContainerResource) => Promise<void>, containerName?: string): PostgresServerResource;
  withPgWeb(configureContainer?: (obj: PgWebContainerResource) => Promise<void>, containerName?: string): PostgresServerResource;
  withRepl(): PostgresServerResource;
  withUserName(userName: ParameterResource): PostgresServerResource;
}

22 members

Properties

propertyconnectionStringExpressionReferenceExpressionget

Gets the connection string expression for the PostgreSQL server.

propertydatabasesDict<string,string>get

A dictionary where the key is the resource name and the value is the database name.

propertyhostEndpointReferenceExpressionget

Gets the host endpoint reference for this service.

propertyjdbcConnectionStringReferenceExpressionget

Gets the JDBC connection string for the PostgreSQL server.

propertypasswordParameterParameterResourceget · set

Gets or sets the parameter that contains the PostgreSQL server password.

propertyportEndpointReferenceExpressionget

Gets the endpoint reference expression that identifies the port for this endpoint.

propertyprimaryEndpointEndpointReferenceget

Gets the primary endpoint for the PostgreSQL server.

propertyuriExpressionReferenceExpressionget

Gets the connection URI expression for the PostgreSQL server.

propertyuserNameParameterParameterResourceget · set

Gets or sets the parameter that contains the PostgreSQL server user name.

propertyuserNameReferenceReferenceExpressionget

Gets a reference to the user name for the PostgreSQL server.

Methods

methodaddDatabasebuilder

Adds a PostgreSQL database to the application model.

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

Parameters

namestring

databaseNamestringoptional

Returns

PostgresDatabaseResource

methodwithDataBindMountbuilder

Adds a bind mount for the data folder to a PostgreSQL container resource.

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

Parameters

sourcestring

isReadOnlybooleanoptional= False

Returns

PostgresServerResource

methodwithDataVolumebuilder

Adds a named volume for the data folder to a PostgreSQL container resource.

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

Parameters

namestringoptional

isReadOnlybooleanoptional= False

Returns

PostgresServerResource

methodwithHostPortbuilder

Configures the host port that the PostgreSQL resource is exposed on instead of using randomly assigned port.

withHostPort(port: number): PostgresServerResource

Parameters

portnumber

Returns

PostgresServerResource

methodwithInitFilesbuilder

Copies init files to a PostgreSQL container resource.

withInitFiles(source: string): PostgresServerResource

Parameters

sourcestring

Returns

PostgresServerResource

methodwithPasswordbuilder

Configures the password that the PostgreSQL resource is used.

withPassword(password: ParameterResource): PostgresServerResource

Parameters

passwordParameterResource

Returns

PostgresServerResource

methodwithPgAdminbuilder

Adds a pgAdmin 4 administration and development platform for PostgreSQL to the application model.

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

Parameters

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

containerNamestringoptional

Returns

PostgresServerResource

methodwithPgWebbuilder

Adds an administration and development platform for PostgreSQL to the application model using pgweb.

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

Parameters

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

containerNamestringoptional

Returns

PostgresServerResource

methodwithReplbuilder

Adds a REPL command that opens an authenticated PostgreSQL shell in the dashboard terminal dock.

withRepl(): PostgresServerResource

Returns

PostgresServerResource

methodwithUserNamebuilder

Configures the user name that the PostgreSQL resource is used.

withUserName(userName: ParameterResource): PostgresServerResource

Parameters

userNameParameterResource

Returns

PostgresServerResource