Share via

PostgresDatabaseResource Class

Definition

Namespace:
Aspire.Hosting.ApplicationModel
Assembly:
Aspire.Hosting.PostgreSQL.dll
Package:
Aspire.Hosting.PostgreSQL v8.2.0
Package:
Aspire.Hosting.PostgreSQL v9.5.0
Source:
PostgresDatabaseResource.cs
Source:
PostgresDatabaseResource.cs
Source:
PostgresDatabaseResource.cs
Source:
PostgresDatabaseResource.cs
Source:
PostgresDatabaseResource.cs
Source:
PostgresDatabaseResource.cs

A resource that represents a PostgreSQL database. This is a child resource of a PostgresServerResource.

public class PostgresDatabaseResource : Aspire.Hosting.ApplicationModel.Resource, Aspire.Hosting.ApplicationModel.IResourceWithConnectionString, Aspire.Hosting.ApplicationModel.IResourceWithParent<Aspire.Hosting.ApplicationModel.PostgresServerResource>
type PostgresDatabaseResource = class
    inherit Resource
    interface IResourceWithParent<PostgresServerResource>
    interface IResourceWithParent
    interface IResource
    interface IResourceWithConnectionString
    interface IManifestExpressionProvider
    interface IValueProvider
    interface IValueWithReferences
Public Class PostgresDatabaseResource
Inherits Resource
Implements IResourceWithConnectionString, IResourceWithParent(Of PostgresServerResource)
Inheritance
Object
Resource
PostgresDatabaseResource
Implements
IManifestExpressionProvider IResource IResourceWithConnectionString IResourceWithParent IResourceWithParent<PostgresServerResource> IValueProvider IValueWithReferences

Constructors

PostgresDatabaseResource(String, String, PostgresServerResource)

A resource that represents a PostgreSQL database. This is a child resource of a PostgresServerResource.

Properties

Annotations

Gets the annotations associated with the resource.

(Inherited from Resource)
ConnectionStringExpression

Gets the connection string expression for the Postgres database.
DatabaseName

Gets the database name.
Name

Gets the name of the resource.

(Inherited from Resource)
Parent

Gets the parent PostgresSQL container resource.

Extension Methods

GetDeploymentTargetAnnotation(IResource, IComputeEnvironmentResource)

Gets the deployment target for the specified resource, if any. Throws an exception if there are multiple compute environments and a compute environment is not explicitly specified.
GetReplicaCount(IResource)

Gets the number of replicas for the specified resource. Defaults to 1 if no ReplicaAnnotation is found.
HasAnnotationIncludingAncestorsOfType<T>(IResource)

Gets whether resource or its ancestors have an annotation of type T
HasAnnotationOfType<T>(IResource)

Gets whether resource has an annotation of type T
IsExcludedFromPublish(IResource)

Gets a value indicating whether the resource is excluded from being published.
ProcessArgumentValuesAsync(IResource, DistributedApplicationExecutionContext, Action<Object,String,Exception,Boolean>, ILogger, String, CancellationToken)

Processes argument values for the specified resource in the given execution context.
ProcessEnvironmentVariableValuesAsync(IResource, DistributedApplicationExecutionContext, Action<String,Object,String,Exception>, ILogger, String, CancellationToken)

Processes environment variable values for the specified resource within the given execution context.
RequiresImageBuildAndPush(IResource)

Determines whether the specified resource requires image building and pushing.
TryGetAnnotationsIncludingAncestorsOfType<T>(IResource, IEnumerable<T>)

Attempts to retrieve all annotations of the specified type from the given resource including from parents.
TryGetAnnotationsOfType<T>(IResource, IEnumerable<T>)

Attempts to retrieve all annotations of the specified type from the given resource.
TryGetContainerImageName(IResource, String)

Attempts to get the container image name from the given resource.
TryGetContainerMounts(IResource, IEnumerable<ContainerMountAnnotation>)

Attempts to get the container mounts for the specified resource.
TryGetEndpoints(IResource, IEnumerable<EndpointAnnotation>)

Attempts to retrieve the endpoints for the given resource.
TryGetEnvironmentVariables(IResource, IEnumerable<EnvironmentCallbackAnnotation>)

Attempts to get the environment variables from the given resource.
TryGetLastAnnotation<T>(IResource, T)

Attempts to get the last annotation of the specified type from the resource.
TryGetUrls(IResource, IEnumerable<ResourceUrlAnnotation>)

Attempts to retrieve the URLs for the given resource.
AsProvisioningParameter(IManifestExpressionProvider, AzureResourceInfrastructure, String, Nullable<Boolean>)

Creates a new ProvisioningParameter in infrastructure, or reuses an existing bicep parameter if one with
IsContainer(IResource)

Determines whether the specified resource is a container resource.
AsEnvironmentPlaceholder(IManifestExpressionProvider, DockerComposeServiceResource)

Creates a placeholder for an environment variable in the Docker Compose file.
IsEmulator(IResource)

Determines whether the specified resource is an emulator resource.
IsExisting(IResource)

Determines if the resource is an existing resource.

Applies to