Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

OracleDatabaseServerResource

Handle
📦 Aspire.Hosting.Oracle v17.0.0

A resource that represents an Oracle Database container.

type OracleDatabaseServerResource interface {
ExpressionValue
IComputeResource
Resource
ResourceWithArgs
ResourceWithConnectionString
ResourceWithEndpoints
ResourceWithEnvironment
ResourceWithWaitSupport
}

Properties

propertyConnectionStringExpression*ReferenceExpressionget
Gets the connection string expression for the Oracle Database server.
ConnectionStringExpression() *ReferenceExpression
propertyDatabasesmap[string]stringget
A dictionary where the key is the resource name and the value is the database name.
Databases() (map[string]string, error)
propertyHostEndpointReferenceExpressionget
Gets the host endpoint reference for this resource.
Host() EndpointReferenceExpression
propertyJdbcConnectionString*ReferenceExpressionget
Gets the JDBC connection string for the Oracle Database server.
JdbcConnectionString() *ReferenceExpression
propertyPasswordParameterParameterResourceget
Gets the parameter that contains the Oracle Database server password.
PasswordParameter() ParameterResource
propertyPortEndpointReferenceExpressionget
Gets the port endpoint reference for this resource.
Port() EndpointReferenceExpression
propertyPrimaryEndpointEndpointReferenceget
Gets the primary endpoint for the Oracle server.
PrimaryEndpoint() EndpointReference
propertyResourceTypeDisplayNamestringget
Gets the ResourceTypeDisplayName property
ResourceTypeDisplayName() (string, error)
propertyUriExpression*ReferenceExpressionget
Gets the connection URI expression for the Oracle server.
UriExpression() *ReferenceExpression
propertyUserNameReference*ReferenceExpressionget
Gets a reference to the user name for the Oracle server.
UserNameReference() *ReferenceExpression

Methods

methodAddDatabasebuilder
Adds a Oracle Database database to the application model.
AddDatabase(
name string,
options ...*AddDatabaseOptions,
) OracleDatabaseResource
namestringThe name of the resource. This name will be used as the connection string name when referenced in a dependency.
options...*AddDatabaseOptionsOptional settings, described under 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.
OracleDatabaseResource

The resource builder.

Returns a handle; failures surface later via Err().

methodWithDataBindMountbuilder
Adds a bind mount for the data folder to a Oracle Database server container resource.
WithDataBindMount(source string) OracleDatabaseServerResource
sourcestringThe source directory on the host to mount into the container.
OracleDatabaseServerResource

The resource builder.

Returns a handle; failures surface later via Err().

methodWithDataVolumebuilder
Adds a named volume for the data folder to a Oracle Database server container resource.
WithDataVolume(options ...*WithDataVolumeOptions) OracleDatabaseServerResource
options...*WithDataVolumeOptionsOptional settings, described under 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.
OracleDatabaseServerResource

The resource builder.

Returns a handle; failures surface later via Err().

Adds a bind mount for the database setup folder to a Oracle Database server container resource.
WithDbSetupBindMount(source string) OracleDatabaseServerResource
sourcestringThe source directory on the host to mount into the container.
OracleDatabaseServerResource

The resource builder.

Returns a handle; failures surface later via Err().

methodWithInitFilesbuilder
Copies init files into a Oracle Database server container resource.
WithInitFiles(source string) OracleDatabaseServerResource
sourcestringThe source file or directory on the host to copy into the container.
OracleDatabaseServerResource

The resource builder.

Returns a handle; failures surface later via Err().