Skip to content
Docs Try Aspire
Docs Try

MongoDBBuilderExtensions Methods

Class Methods 1 member
Provides extension methods for adding MongoDB resources to an Hosting.IDistributedApplicationBuilder.
WithDbGate(IResourceBuilder<MongoDBServerResource>, Action<IResourceBuilder<DbGateContainerResource>>, string?) Section titled WithDbGate(IResourceBuilder<MongoDBServerResource>, Action<IResourceBuilder<DbGateContainerResource>>, string?) extension IResourceBuilder<MongoDBServerResource>
Adds an administration and development platform for MongoDB to the application model using DbGate.
public static class MongoDBBuilderExtensions
{
public static IResourceBuilder<MongoDBServerResource> WithDbGate(
this IResourceBuilder<MongoDBServerResource> builder,
Action<IResourceBuilder<DbGateContainerResource>>? configureContainer = null,
string? containerName = null)
{
// ...
}
}
builder IResourceBuilder<MongoDBServerResource> The MongoDB server resource builder.
configureContainer Action<IResourceBuilder<DbGateContainerResource>> optional Configuration callback for DbGate container resource.
containerName string? optional The name of the container (Optional).
IResourceBuilder<MongoDBServerResource> A reference to the ApplicationModel.IResourceBuilder`1.
This version of the package defaults to the tag of the container image. This overload is not available in polyglot app hosts. Use the overload without the configuration callback instead.

Use in application host with a MongoDB resource

var builder = DistributedApplication.CreateBuilder(args);
var mongodb = builder.AddMongoDB("mongodb")
.WithDbGate();
var db = mongodb.AddDatabase("db");
var api = builder.AddProject<Projects.Api>("api")
.WithReference(db);
builder.Build().Run();