/ /

/ /

Librerías de clientes

Driver C#/.NET

Fundamentals

Conexión

Guía de Conexión

Esta guía le muestra cómo conectarse a una instancia de MongoDB o a una implementación de un conjunto de réplicas mediante el controlador .NET/C#.

URI de conexión

Una URI de conexión, también conocida como cadena de conexión, le indica al controlador cómo conectarse a una implementación de MongoDB y cómo comportarse mientras está conectado.

Una cadena de conexión estándar incluye las siguientes piezas:

Pedazo	Descripción
`mongodb://`	Requerido. Un prefijo que identifica esto como un string en el formato de conexión estándar.
`username:password@`	Opcional. Credenciales de autenticación. Si las incluye, el cliente autenticará al usuario en la base de datos especificada en `authSource`.
`host[:port]`	Obligatorio. El host y el número de puerto opcional donde se ejecuta MongoDB. Si no incluye el número de puerto, el controlador usará el puerto predeterminado, `27017`.
`/defaultauthdb`	Opcional. La base de datos de autenticación que se usará si la cadena de conexión incluye las credenciales de autenticación `username:password@`, pero no la opción `authSource`. Si no incluye esta parte, el cliente autenticará al usuario con la base de datos `admin`.
`?<options>`	Opcional. Un string de la query que especifica opciones específicas de conexión como pares `<name>=<value>`. Ver Opciones de conexión para obtener una descripción completa de estas opciones.

Para usar una URI de conexión, pásela como cadena al constructor MongoClient. En el siguiente ejemplo, el controlador usa una URI de conexión de ejemplo para conectarse a una instancia de MongoDB en el puerto 27017 de localhost:

using MongoDB.Driver;
// Sets the connection URI
const string connectionUri = "mongodb://localhost:27017";
// Creates a new client and connects to the server
var client = new MongoClient(connectionUri);

Tip

Reutilizar el cliente

Dado que cada MongoClient representa un conjunto de conexiones a la base de datos, la mayoría de las aplicaciones solo requieren una instancia MongoClient de, incluso en múltiples solicitudes. Para obtener más información sobre el funcionamiento de los conjuntos de conexiones en el controlador, consulte la página de preguntas frecuentes.

Ver El Manual de MongoDB para obtener más información sobre cómo crear una cadena de conexión.

MongoClientSettings

Puede usar un objeto MongoClientSettings para configurar la conexión en el código, en lugar de usar una URI de conexión. Para usar un objeto MongoClientSettings, cree una instancia de la clase y pásela como argumento al constructor MongoClient.

En el siguiente ejemplo, el controlador utiliza un objeto MongoClientSettings para conectar con una instancia de MongoDB en el puerto 27017 de localhost:

using MongoDB.Driver;
// Creates a MongoClientSettings object
var settings = new MongoClientSettings()
{
    Scheme = ConnectionStringScheme.MongoDB,
    Server = new MongoServerAddress("localhost", 27017)
};
// Creates a new client and connects to the server
var client = new MongoClient(settings);

Otros objetivos de conexión

Conectar a Atlas

Para conectarse a una implementación de MongoDB en Atlas, cree un cliente. Puede crear un cliente que utilice su cadena de conexión y otras opciones del cliente pasando un objeto MongoClientSettings al constructor MongoClient.

Para especificar la URI de conexión, pásela al método FromConnectionString(), que devuelve una nueva instancia MongoClientSettings. Para especificar otras opciones del cliente, configure los campos correspondientes del objeto MongoClientSettings.

Puede configurar la versión estable de la API como opción del cliente para evitar cambios importantes al actualizar a una nueva versión del servidor. Para obtener más información sobre la función API estable, consulte la página API estable.

El siguiente código muestra cómo puede especificar la cadena de conexión y la opción de cliente API estable al conectarse a una implementación de MongoDB y verificar que la conexión sea exitosa:

using MongoDB.Driver;
using MongoDB.Bson;
// Replace the placeholder with your Atlas connection string
const string connectionUri = "<connection string>";
var settings = MongoClientSettings.FromConnectionString(connectionUri);
// Sets the ServerApi field of the settings object to Stable API version 1
settings.ServerApi = new ServerApi(ServerApiVersion.V1);
// Creates a new client and connects to the server
var client = new MongoClient(settings);
// Sends a ping to confirm a successful connection
try {
    var result = client.GetDatabase("admin").RunCommand<BsonDocument>(new BsonDocument("ping", 1));
    Console.WriteLine("Pinged your deployment. You successfully connected to MongoDB!");
} catch (Exception ex) { Console.WriteLine(ex);}

Tip

Siga la guía de conexión del controlador Atlas para recuperar su cadena de conexión.

Conectarse a un set de réplicas

Para conectarte a la implementación de un set de réplicas, especifica los nombres de host (o direcciones IP) y los números de puerto de los nodos del set de réplicas.

Si no puede proporcionar una lista completa de hosts en el conjunto de réplicas, puede especificar uno o más de los hosts en el conjunto de réplicas e indicarle al controlador que realice un descubrimiento automático de una de las siguientes maneras:

Especifique el nombre del conjunto de réplicas como el valor del parámetro replicaSet.
Especifique false como el valor del parámetro directConnection.
Especifica más de un host en el conjunto de réplicas.

En el siguiente ejemplo, el controlador utiliza un URI de conexión de muestra para conectarse al conjunto de réplicas de MongoDB sampleRS, que se ejecuta en el puerto 27017 de tres hosts diferentes, incluido sample.host1:

using MongoDB.Driver;
// Sets the connection URI than includes the replica set name
const string connectionUri = "mongodb://sample.host1:27017/?replicaSet=sampleRS";
// Creates a new client and connects to the server
var client = new MongoClient(connectionUri);

Nota

Set de réplicas en Docker

Cuando un set de réplicas se ejecuta en Docker, se podría exponer solo un punto final de MongoDB. En este caso, el set de réplicas no se puede detectar. Si se especifica directConnection=false en la URI de conexión, o se deja esta opción sin configurar, puedes evitar que tu aplicación se conecte a ella.

En un entorno de prueba o desarrollo, se puede conectar al set de réplicas especificando directConnection=true. En un entorno de producción, se recomienda configurar el clúster para que cada instancia de MongoDB sea accesible fuera de la red virtual de Docker.

Volver

Conexión

Opciones de conexión