OracleDatabaseBuilderExtensions Methods

Docs / Reference / Search C# APIs / Aspire.Hosting.Oracle / OracleDatabaseBuilderExtensions / Methods

Methods

Docs Reference Search C# APIs Aspire.Hosting.Oracle OracleDatabaseBuilderExtensions Methods

Class Methods 7 members

Provides extension methods for adding Oracle Database resources to an Hosting.IDistributedApplicationBuilder.

AddDatabase(IResourceBuilder<OracleDatabaseServerResource>, string, string?) extension IResourceBuilder<OracleDatabaseResource>

Adds a Oracle Database database to the application model.

public static class OracleDatabaseBuilderExtensions
{
    public static IResourceBuilder<OracleDatabaseResource> AddDatabase(
        this IResourceBuilder<OracleDatabaseServerResource> builder,
        string name,
        string? databaseName = null)
    {
        // ...
    }
}

OracleDatabaseBuilderExtensions.cs#L81-L89

Parameters

builder IResourceBuilder<OracleDatabaseServerResource> The Oracle Database server resource builder.

name string The name of the resource. This name will be used as the connection string name when referenced in a dependency.

databaseName string? optional The name of the database. If not provided, this defaults to the same value as name.

Returns

IResourceBuilder<OracleDatabaseResource> A reference to the ApplicationModel.IResourceBuilder`1.

AddOracle(IDistributedApplicationBuilder, string, IResourceBuilder<ParameterResource>, int?) extension IResourceBuilder<OracleDatabaseServerResource>

Adds a Oracle Server resource to the application model. A container is used for local development.

public static class OracleDatabaseBuilderExtensions
{
    public static IResourceBuilder<OracleDatabaseServerResource> AddOracle(
        this IDistributedApplicationBuilder builder,
        string name,
        IResourceBuilder<ParameterResource>? password = null,
        int? port = null)
    {
        // ...
    }
}

OracleDatabaseBuilderExtensions.cs#L34-L66

Parameters

builder IDistributedApplicationBuilder The Hosting.IDistributedApplicationBuilder.

name string The name of the resource. This name will be used as the connection string name when referenced in a dependency.

password IResourceBuilder<ParameterResource> optional The parameter used to provide the administrator password for the Oracle Server resource. If null a random password will be generated.

port int? optional The host port for Oracle Server.

Returns

IResourceBuilder<OracleDatabaseServerResource> A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

This version of the package defaults to the tag of the / container image.

WithDataBindMount(IResourceBuilder<OracleDatabaseServerResource>, string) extension IResourceBuilder<OracleDatabaseServerResource>

Adds a bind mount for the data folder to a Oracle Database server container resource.

public static class OracleDatabaseBuilderExtensions
{
    public static IResourceBuilder<OracleDatabaseServerResource> WithDataBindMount(
        this IResourceBuilder<OracleDatabaseServerResource> builder,
        string source)
    {
        // ...
    }
}

OracleDatabaseBuilderExtensions.cs#L113-L116

Parameters

builder IResourceBuilder<OracleDatabaseServerResource> The resource builder.

source string The source directory on the host to mount into the container.

Returns

IResourceBuilder<OracleDatabaseServerResource> The ApplicationModel.IResourceBuilder`1.

WithDataVolume(IResourceBuilder<OracleDatabaseServerResource>, string?) extension IResourceBuilder<OracleDatabaseServerResource>

Adds a named volume for the data folder to a Oracle Database server container resource.

public static class OracleDatabaseBuilderExtensions
{
    public static IResourceBuilder<OracleDatabaseServerResource> WithDataVolume(
        this IResourceBuilder<OracleDatabaseServerResource> builder,
        string? name = null)
    {
        // ...
    }
}

OracleDatabaseBuilderExtensions.cs#L100-L102

Parameters

builder IResourceBuilder<OracleDatabaseServerResource> The resource builder.

name string? optional The name of the volume. Defaults to an auto-generated name based on the application and resource names.

Returns

IResourceBuilder<OracleDatabaseServerResource> The ApplicationModel.IResourceBuilder`1.

WithDbSetupBindMount(IResourceBuilder<OracleDatabaseServerResource>, string) extension IResourceBuilder<OracleDatabaseServerResource>

Adds a bind mount for the database setup folder to a Oracle Database server container resource.

public static class OracleDatabaseBuilderExtensions
{
    public static IResourceBuilder<OracleDatabaseServerResource> WithDbSetupBindMount(
        this IResourceBuilder<OracleDatabaseServerResource> builder,
        string source)
    {
        // ...
    }
}

OracleDatabaseBuilderExtensions.cs#L160-L163

Parameters

builder IResourceBuilder<OracleDatabaseServerResource> The resource builder.

source string The source directory on the host to mount into the container.

Returns

IResourceBuilder<OracleDatabaseServerResource> The ApplicationModel.IResourceBuilder`1.

Obsolete — Use WithInitFiles instead.

WithInitBindMount(IResourceBuilder<OracleDatabaseServerResource>, string) extension IResourceBuilder<OracleDatabaseServerResource>

Adds a bind mount for the init folder to a Oracle Database server container resource.

public static class OracleDatabaseBuilderExtensions
{
    public static IResourceBuilder<OracleDatabaseServerResource> WithInitBindMount(
        this IResourceBuilder<OracleDatabaseServerResource> builder,
        string source)
    {
        // ...
    }
}

OracleDatabaseBuilderExtensions.cs#L128-L131

Parameters

builder IResourceBuilder<OracleDatabaseServerResource> The resource builder.

source string The source directory on the host to mount into the container.

Returns

IResourceBuilder<OracleDatabaseServerResource> The ApplicationModel.IResourceBuilder`1.

WithInitFiles(IResourceBuilder<OracleDatabaseServerResource>, string) extension IResourceBuilder<OracleDatabaseServerResource>

Copies init files into a Oracle Database server container resource.

public static class OracleDatabaseBuilderExtensions
{
    public static IResourceBuilder<OracleDatabaseServerResource> WithInitFiles(
        this IResourceBuilder<OracleDatabaseServerResource> builder,
        string source)
    {
        // ...
    }
}

OracleDatabaseBuilderExtensions.cs#L142-L149

Parameters

builder IResourceBuilder<OracleDatabaseServerResource> The resource builder.

source string The source file or directory on the host to copy into the container.

Returns

IResourceBuilder<OracleDatabaseServerResource> The ApplicationModel.IResourceBuilder`1.