Aspire.Hosting.MongoDB

MongoDB hosting integration

Use this integration to model, configure, and orchestrate a MongoDB resource in an Aspire solution.

Getting started

Add the integration

From your AppHost directory, add the Aspire.Hosting.MongoDB integration with the Aspire CLI:

aspire add Aspire.Hosting.MongoDB

Usage example

In the AppHost, add a MongoDB resource and reference it from another resource with either C# or TypeScript:

C#

var db = builder.AddMongoDB("mongodb").AddDatabase("mydb");

var myService = builder.AddProject<Projects.MyService>()
                       .WithReference(db);

TypeScript

const db = await builder.addMongoDB("mongodb").addDatabase("mydb");

const myService = await builder.addNodeApp("myService", "../my-service", "server.js")
                       .withReference(db);

Connection Properties

When you reference a MongoDB resource using WithReference, the following connection properties are made available to the consuming project:

MongoDB server

The MongoDB server resource exposes the following connection properties:

MongoDB database

The MongoDB database resource combines the server properties above and adds the following connection property:

Aspire exposes each property as an environment variable named [RESOURCE]_[PROPERTY]. For instance, the Uri property of a resource called db1 becomes DB1_URI.

Additional documentation

• https://aspire.dev/integrations/gallery/
• https://aspire.dev/integrations/databases/mongodb/mongodb-host/

Feedback & contributing

https://github.com/microsoft/aspire