MongoDB C#/.NET Driver

Introduction

Welcome to the documentation site for the official MongoDB C#/.NET driver. You can add the driver to your application to work with MongoDB in C#/.NET. Download it using NuGet or set up a runnable project by following our Getting Started guide.

• Getting Started
• API Reference
• Changelog
• Source Code

Take the free online course taught by MongoDB

	M220N: MongoDB for .NET Developers Learn the essentials of C# & ASP.NET application development with MongoDB.

Installation

NuGet is the simplest way to get the driver. Use MongoDB.Driver for all new projects.

For more information, see Installation.

Connect to MongoDB Atlas

To connect to a MongoDB Atlas cluster, use the Atlas connection string for your cluster:

using MongoDB.Bson;
using MongoDB.Driver;
// Replace the uri string with your MongoDB deployment's connection string.
var client = new MongoClient(
    "mongodb+srv://<username>:<password>@<cluster-address>/test?w=majority"
);
var database = client.GetDatabase("test");

See Connecting for more information.

Versioned API

You can use the Versioned API feature starting with MongoDB Server version 5.0 and C#/.NET Driver version 2.13. When you use the Versioned API feature, you can update your driver or server without worrying about backward compatibility issues with any commands covered by the Versioned API. To use this feature, construct a MongoDB client instance, specifying a version of the Versioned API:

// Replace <connection string> with your MongoDB deployment's connection string.
var settings = MongoClientSettings.FromConnectionString("<connection string>");
// Set the version of the Versioned API on the client.
settings.ServerApi = new ServerApi(ServerApiVersion.V1);
var client = new MongoClient(settings);

Connect to a MongoDB Server on Your Local Machine

If you need to run a MongoDB server on your local machine for development purposes instead of using an Atlas cluster, you need to complete the following:

1. Download the Community or Enterprise version of MongoDB Server.
2. Install and configure MongoDB Server.
3. Start the server.

After you successfully start your MongoDB server, specify your connection string in your driver connection code.

If your MongoDB Server is running locally, you can use the connection string "mongodb://localhost:<port>" where <port> is the port number you configured your server to listen for incoming connections.

If you need to specify a different hostname or IP address, see our Server Manual entry on Connection Strings.

To test whether you can connect to your server, replace the connection string in the Connect to MongoDB Atlas code example and run it.

Compatibility