PrimaryEndpoint EndpointReference getPrimaryEndpoint() EndpointReferenceAPI references are intentionally omitted from this search. To find API references, please search these dedicated API pages instead:
A resource that represents a PostgreSQL container.
type PostgresServerResource interface { ExpressionValue IComputeResource Resource ResourceWithArgs ResourceWithConnectionString ResourceWithEndpoints ResourceWithEnvironment ResourceWithWaitSupport}ConnectionStringExpression *ReferenceExpression getConnectionStringExpression() *ReferenceExpressionDatabasesmap[string]string getDatabases() (map[string]string, error)HostEndpointReferenceExpression getHost() EndpointReferenceExpressionJdbcConnectionString *ReferenceExpression getJdbcConnectionString() *ReferenceExpressionPasswordParameter ParameterResource get · setPasswordParameter() ParameterResourceSetPasswordParameter(value ParameterResource) PostgresServerResourcePortEndpointReferenceExpression getPort() EndpointReferenceExpressionPrimaryEndpoint EndpointReference getPrimaryEndpoint() EndpointReferenceResourceTypeDisplayName stringgetResourceTypeDisplayName() (string, error)UriExpression *ReferenceExpression getUriExpression() *ReferenceExpressionUserNameParameter ParameterResource get · setUserNameParameter() ParameterResourceSetUserNameParameter(value ParameterResource) PostgresServerResourceUserNameReference *ReferenceExpression getUserNameReference() *ReferenceExpressionAddDatabase( name string, options ...*AddDatabaseOptions,) PostgresDatabaseResourceParameters
namestringThe name of the resource. This name will be used as the connection string name when referenced in a dependency.options...*AddDatabaseOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*AddDatabaseOptions argument.
DatabaseName *stringThe name of the database. If not provided, this defaults to the same value as name.Returns
PostgresDatabaseResource The resource builder.
Returns a handle; failures surface later via Err().
WithDataBindMount( source string, options ...*WithDataBindMountOptions,) PostgresServerResourceParameters
sourcestringThe source directory on the host to mount into the container.options...*WithDataBindMountOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*WithDataBindMountOptions argument.
IsReadOnly *boolA flag that indicates if this is a read-only mount.Returns
PostgresServerResource The resource builder.
Returns a handle; failures surface later via Err().
WithDataVolume(options ...*WithDataVolumeOptions) PostgresServerResourceParameters
options...*WithDataVolumeOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*WithDataVolumeOptions argument.
Name*stringThe name of the volume. Defaults to an auto-generated name based on the application and resource names.IsReadOnly *boolA flag that indicates if this is a read-only volume.Returns
PostgresServerResource The resource builder.
Returns a handle; failures surface later via Err().
WithHostPort(port *float64) PostgresServerResourceParameters
port*float64The port to bind on the host. If null is used random port will be assigned.Returns
PostgresServerResource The resource builder.
Returns a handle; failures surface later via Err().
WithInitFiles(source string) PostgresServerResourceParameters
sourcestringThe source directory or files on the host to copy into the container.Returns
PostgresServerResource The resource builder.
Returns a handle; failures surface later via Err().
WithPassword(password ParameterResource) PostgresServerResourceParameters
passwordParameterResource The parameter used to provide the password for the PostgreSQL resource.Returns
PostgresServerResource The resource builder.
Returns a handle; failures surface later via Err().
WithPgAdmin(options ...*WithPgAdminOptions) PostgresServerResourceParameters
options...*WithPgAdminOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*WithPgAdminOptions argument.
ConfigureContainer func(obj PgAdminContainerResource) callbackCallback to configure PgAdmin container resource.ContainerName *stringThe name of the container (Optional).Returns
PostgresServerResource The resource builder.
Returns a handle; failures surface later via Err().
WithPgWeb(options ...*WithPgWebOptions) PostgresServerResourceParameters
options...*WithPgWebOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*WithPgWebOptions argument.
ConfigureContainer func(obj PgWebContainerResource) callbackConfiguration callback for pgweb container resource.ContainerName *stringThe name of the container (Optional).Returns
PostgresServerResource The resource builder.
Returns a handle; failures surface later via Err().
WithRepl() PostgresServerResourceReturns
PostgresServerResource The resource builder for chaining.
Returns a handle; failures surface later via Err().
WithUserName(userName ParameterResource) PostgresServerResourceParameters
userName ParameterResource The parameter used to provide the user name for the PostgreSQL resource.Returns
PostgresServerResource The resource builder.
Returns a handle; failures surface later via Err().