index.txt

=================
MongoDB C# Driver
=================

.. facet::
   :name: programming_language
   :values: csharp

.. meta::
   :keywords: dotnet

.. toctree::

   /previous-versions
   /quick-start
   /quick-reference
   /whats-new
   /usage-examples
   /fundamentals
   API Documentation <{+new-api-root+}/index.html>
   /faq
   /connection-troubleshooting
   /issues-and-help
   /compatibility
   /upgrade
   Entity Framework Provider <https://www.mongodb.com/docs/entity-framework/current/>
   {+analyzer-short+} <https://www.mongodb.com/docs/mongodb-analyzer/>

Introduction
------------

Welcome to the documentation site for the official {+driver-long+}.
You can add the driver to your application to work with MongoDB in {+language+}.
Download the driver using `NuGet <https://www.nuget.org/packages/MongoDB.Driver>`__, or set up a runnable
project by following our :ref:`Quick Start guide <csharp-quickstart>`.

Previous Versions
-----------------

For documentation on versions of the driver v2.18 and earlier, see the :ref:`csharp-previous-versions` section.

Connect to a Compatible MongoDB Deployment
------------------------------------------

You can use the {+driver-short+} to connect to MongoDB
deployments running on one of the following hosted services or editions:

.. include:: /includes/fact-environments.rst

Quick Start
-----------

Learn how to establish a connection to MongoDB Atlas and begin
working with data in the :ref:`csharp-quickstart` section!

Quick Reference
---------------

See driver syntax examples for common MongoDB commands in the
:ref:`Quick Reference <csharp-quick-reference>` section.

What's New
----------

For a list of new features and changes in each version, see the :ref:`What's New <csharp-whats-new>`
section.

Usage Examples
--------------

For fully runnable code snippets and explanations for common
methods, see :ref:`csharp-usage-examples`.

Fundamentals
------------

For detailed information on key concepts of using the {+driver-short+}, see
:ref:`csharp-fundamentals`.

API Documentation
-----------------

For detailed information about types and methods in the {+driver-short+}, see
the `{+driver-long+} API documentation
<{+new-api-root+}/index.html>`__.

Take the Free Online Course Taught by MongoDB
---------------------------------------------

.. list-table::

   * - .. figure:: /includes/figures/M220N.png
          :alt: Banner for the C# MongoDB University Course

     - `Using MongoDB with C# <https://learn.mongodb.com/learning-paths/using-mongodb-with-csharp>`__

       Learn the essentials of C# & ASP.NET application development with MongoDB.

FAQ
---

For answers to commonly asked questions about the {+driver-long+}, see the :ref:`csharp-faq`
section.

Connection Troubleshooting
--------------------------

For solutions to issues you might encounter when using the driver to connect to
a MongoDB deployment, see the :ref:`csharp-connection-troubleshooting` section.

Issues & Help
-------------

Learn how to report bugs, contribute to the driver, and find
additional resources for asking questions in the :ref:`csharp-issues-help` section.

Compatibility
-------------

For the compatibility charts that show the recommended {+driver-short+} version
for each {+mdb-server+} version, see :ref:`csharp-compatibility-tables`.

Upgrade Driver Versions
-----------------------

Learn what changes you may need to make to your application to upgrade
driver versions in the :ref:`Upgrade Driver Versions <csharp-upgrade-driver>`
section.

Entity Framework Provider
-------------------------

The MongoDB Entity Framework Provider is an object-relational mapper (ORM) that lets you
use Microsoft's Entity Framework to work with MongoDB data. ORMs provide an
object-oriented interface for data management.

To learn more, see the
`MongoDB Entity Framework Provider documentation <https://www.mongodb.com/docs/entity-framework/current/>`__.

{+analyzer+}
-------------------

The {+analyzer-short+} is a tool that helps you understand how your
{+driver-short+} code translates into the {+query-api+} and if your code
includes any unsupported LINQ or builder expressions. To learn more, see the
`{+analyzer-short+} documentation <https://www.mongodb.com/docs/mongodb-analyzer>`__.