/ /

Especifica opciones de conexión

Docs Home

/ /

Driver C#/.NET

Especifica opciones de conexión

Docs Home

Librerías de clientes

Driver C#/.NET

Especifica opciones de conexión

Stable API

Overview

En esta guía, puede aprender cómo especificar la compatibilidad de API estable al conectarse a una instancia de MongoDB o un conjunto de réplicas.

La función API estable obliga al servidor a ejecutar operaciones con comportamientos compatibles con la versión de API que especifique. Al actualizar el controlador o el servidor, la versión de API cambia, lo que puede modificar el comportamiento de estas operaciones. El uso de la API estable garantiza respuestas consistentes del servidor y proporciona estabilidad de API a largo plazo para su aplicación.

Las siguientes secciones describen cómo habilitar y personalizar la API estable para su cliente MongoDB. Para obtener más información sobre la API estable, incluyendo una lista de los comandos que abarca, consulte Página de referencia de MongoDB.

Habilitar la API estable en un cliente MongoDB

Para habilitar la API estable, debe especificar una versión de la API en la configuración de su cliente MongoDB. Una vez que cree una instancia de MongoClient instancia con una versión de API especificada, todos los comandos que ejecuta con el cliente usan esa versión de la API estable.

Tip

Una vez creado un MongoClient, no se puede cambiar su versión de la API estable. Si necesita ejecutar comandos con más de una versión de la API estable, cree una instancia de cliente independiente con esa versión.

Si necesita ejecutar comandos no contemplados en la API estable, asegúrese de que la opción "strict" esté deshabilitada. Consulte la sección "Opciones de la API estable" para obtener más información.

El siguiente ejemplo muestra cómo puede crear una instancia de MongoClient con una versión de API estable y conectarse a un servidor a través de las siguientes operaciones:

Construye una instancia de ServerApi y especifica una versión de Stable API.
Construya un objeto MongoClientSettings y establezca la propiedad ServerApi.
Crea un MongoClient con el objeto MongoClientSettings.

var serverApi = new ServerApi(ServerApiVersion.V1);
var settings = new MongoClientSettings { ServerApi = serverApi };
var client = new MongoClient(settings);

Advertencia

Si especifica una versión de API y se conecta a un servidor MongoDB que no es compatible con la API estable, su código podría generar una excepción al ejecutar un comando en su servidor MongoDB. Si usa un MongoClient que especifica la versión de API para consultar un servidor que no la admite, la consulta podría fallar con un mensaje de excepción con el siguiente texto:

Unrecognized field 'apiVersion' on server...

Opciones de Stable API

Puede utilizar las opciones de la siguiente tabla para personalizar el comportamiento de la API estable.

Nombre de la opción	Descripción
Estricto	Optional. When `true`, if you call a command that is not part of the declared API version, the driver raises an exception. Default: false
Errores de desuso	Optional. When `true`, if you call a command that is deprecated in the declared API version, the driver raises an exception. Default: false

El siguiente ejemplo muestra cómo puede configurar estas opciones al construir un objeto ServerApi:

var serverApi = new ServerApi(ServerApiVersion.V1, strict: true,
    deprecationErrors: true);

Documentación de la API

Para obtener más información sobre el uso de la API estable con el controlador MongoDB .NET/C#, consulte la siguiente documentación de la API:

Volver

Personalizar selección de servidor

Pools de conexiones