Get started with the MongoDB integrations

MongoDB is a NoSQL database that provides high performance, high availability, and easy scalability. The MongoDB integration enables you to connect to existing MongoDB instances (including MongoDB Atlas) or create new instances from Aspire with the docker.io/library/mongo container image.

In this introduction, you'll see how to install and use the Aspire MongoDB integrations in a simple configuration. If you already have this knowledge, see MongoDB Hosting integration for full reference details.

Note

To follow this guide, you must have created an Aspire solution to work with. To learn how to do that, see Build your first Aspire app.

Set up hosting integration

To begin, install the Aspire MongoDB Hosting integration in your Aspire AppHost project. This integration allows you to create and manage MongoDB database instances from your Aspire hosting projects:

Install the NuGet package

dotnet add package Aspire.Hosting.MongoDB

Next, in the AppHost project, create instances of MongoDB server and database resources, then pass the database to the consuming client projects:

Tip

This is the simplest implementation of MongoDB resources in the AppHost. There are many more options you can choose from to address your requirements. For full details, see MongoDB Hosting integration.

Use the integration in client projects

Now that the hosting integration is ready, the next step is to install and configure the client integration in any projects that need to use it.

Set up client projects

Use injected MongoDB properties

In the AppHost, when you used the WithReference method to pass a MongoDB database resource to a consuming client project, Aspire injects several configuration properties that you can use in the consuming project.

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

Tip

The full set of properties that Aspire injects depends on the MongoDB resource configuration. For more information, see Properties of the MongoDB resources.

Use MongoDB resources in client code

Next steps

Now, that you have an Aspire app with MongoDB integrations up and running, you can use the following reference documents to learn how to configure and interact with the MongoDB resources:

<LinkCard Title="Understand the MongoDB hosting integration"

<LinkCard Title="Understand the MongoDB client integration"

<LinkCard Title="Community extensions"