MongoDBBuilderExtensions Methods

AddDatabase(IResourceBuilder<MongoDBServerResource>, string, string?)extensionIResourceBuilder<MongoDBDatabaseResource>

Adds a MongoDB database to the application model.

public static class MongoDBBuilderExtensions
{
    public static IResourceBuilder<MongoDBDatabaseResource> AddDatabase(
        this IResourceBuilder<MongoDBServerResource> builder,
        string name,
        string? databaseName = null)
    {
        // ...
    }
}

MongoDBBuilderExtensions.cs#L109-L142

Parameters

builderIResourceBuilder<MongoDBServerResource>The MongoDB server resource builder.

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

databaseNamestring?optionalThe name of the database. If not provided, this defaults to the same value as name.

Returns

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

AddMongoDB(IDistributedApplicationBuilder, string, int?)extensionIResourceBuilder<MongoDBServerResource>

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

public static class MongoDBBuilderExtensions
{
    public static IResourceBuilder<MongoDBServerResource> AddMongoDB(
        this IDistributedApplicationBuilder builder,
        string name,
        int? port)
    {
        // ...
    }
}

MongoDBBuilderExtensions.cs#L37

Parameters

builderIDistributedApplicationBuilderThe Hosting.IDistributedApplicationBuilder.

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

portint?The host port for MongoDB.

Returns

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

Remarks

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

This overload is not available in polyglot app hosts. Use MongoDBBuilderExtensions.AddMongoDB instead.

AddMongoDB(IDistributedApplicationBuilder, string, int?, IResourceBuilder<ParameterResource>, IResourceBuilder<ParameterResource>)

extensionIResourceBuilder<MongoDBServerResource>

public static class MongoDBBuilderExtensions
{
    public static IResourceBuilder<MongoDBServerResource> AddMongoDB(
        this IDistributedApplicationBuilder builder,
        string name,
        int? port = null,
        IResourceBuilder<ParameterResource>? userName = null,
        IResourceBuilder<ParameterResource>? password = null)
    {
        // ...
    }
}

MongoDBBuilderExtensions.cs#L58-L95

Parameters

builderIDistributedApplicationBuilderThe Hosting.IDistributedApplicationBuilder.

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

portint?optionalThe host port for MongoDB.

userNameIResourceBuilder<ParameterResource>optionalA parameter that contains the MongoDb server user name, or null to use a default value.

passwordIResourceBuilder<ParameterResource>optionalA parameter that contains the MongoDb server password, or null to use a generated password.

Returns

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

WithDataBindMount(IResourceBuilder<MongoDBServerResource>, string, bool)extensionIResourceBuilder<MongoDBServerResource>

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

public static class MongoDBBuilderExtensions
{
    public static IResourceBuilder<MongoDBServerResource> WithDataBindMount(
        this IResourceBuilder<MongoDBServerResource> builder,
        string source,
        bool isReadOnly = false)
    {
        // ...
    }
}

MongoDBBuilderExtensions.cs#L223-L226

Parameters

builderIResourceBuilder<MongoDBServerResource>The resource builder.

sourcestringThe source directory on the host to mount into the container.

isReadOnlybooloptionalA flag that indicates if this is a read-only mount.

Returns

IResourceBuilder<MongoDBServerResource>The ApplicationModel.IResourceBuilder`1.

WithDataVolume(IResourceBuilder<MongoDBServerResource>, string?, bool)extensionIResourceBuilder<MongoDBServerResource>

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

public static class MongoDBBuilderExtensions
{
    public static IResourceBuilder<MongoDBServerResource> WithDataVolume(
        this IResourceBuilder<MongoDBServerResource> builder,
        string? name = null,
        bool isReadOnly = false)
    {
        // ...
    }
}

MongoDBBuilderExtensions.cs#L207-L209

Parameters

builderIResourceBuilder<MongoDBServerResource>The resource builder.

namestring?optionalThe name of the volume. Defaults to an auto-generated name based on the application and resource names.

isReadOnlybooloptionalA flag that indicates if this is a read-only volume.

Returns

IResourceBuilder<MongoDBServerResource>The ApplicationModel.IResourceBuilder`1.

WithHostPort(IResourceBuilder<MongoExpressContainerResource>, int?)extensionIResourceBuilder<MongoExpressContainerResource>

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

public static class MongoDBBuilderExtensions
{
    public static IResourceBuilder<MongoExpressContainerResource> WithHostPort(
        this IResourceBuilder<MongoExpressContainerResource> builder,
        int? port)
    {
        // ...
    }
}

MongoDBBuilderExtensions.cs#L188-L193

Parameters

builderIResourceBuilder<MongoExpressContainerResource>The resource builder for Mongo Express.

portint?The port to bind on the host. If null is used random port will be assigned.

Returns

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

WithInitBindMount(IResourceBuilder<MongoDBServerResource>, string, bool)extensionIResourceBuilder<MongoDBServerResource>

Adds a bind mount for the init folder to a MongoDB container resource.

public static class MongoDBBuilderExtensions
{
    public static IResourceBuilder<MongoDBServerResource> WithInitBindMount(
        this IResourceBuilder<MongoDBServerResource> builder,
        string source,
        bool isReadOnly = true)
    {
        // ...
    }
}

MongoDBBuilderExtensions.cs#L241-L244

Parameters

builderIResourceBuilder<MongoDBServerResource>The resource builder.

sourcestringThe source directory on the host to mount into the container.

isReadOnlybooloptionalA flag that indicates if this is a read-only mount.

Returns

IResourceBuilder<MongoDBServerResource>The ApplicationModel.IResourceBuilder`1.

Remarks

This method is not available in polyglot app hosts. Use MongoDBBuilderExtensions.WithInitFiles instead.

WithInitFiles(IResourceBuilder<MongoDBServerResource>, string)extensionIResourceBuilder<MongoDBServerResource>

Copies init files into a MongoDB container resource.

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

MongoDBBuilderExtensions.cs#L257-L264

Parameters

builderIResourceBuilder<MongoDBServerResource>The resource builder.

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

Returns

IResourceBuilder<MongoDBServerResource>The ApplicationModel.IResourceBuilder`1.

WithMongoExpress(IResourceBuilder<T>, Action<IResourceBuilder<MongoExpressContainerResource>>, string?)extensionIResourceBuilder<T>

Adds a MongoExpress administration and development platform for MongoDB to the application model.

public static class MongoDBBuilderExtensions
{
    public static IResourceBuilder<T> WithMongoExpress<T>(
        this IResourceBuilder<T> builder,
        Action<IResourceBuilder<MongoExpressContainerResource>>? configureContainer = null,
        string? containerName = null)
    {
        // ...
    }
}

MongoDBBuilderExtensions.cs#L160-L175

Parameters

builderIResourceBuilder<T>The MongoDB server resource builder.

configureContainerAction<IResourceBuilder<MongoExpressContainerResource>>optionalConfiguration callback for Mongo Express container resource.

containerNamestring?optionalThe name of the container (Optional).

Returns

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

Remarks

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