/ /

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, puedes aprender a especificar la compatibilidad con Stable API al conectar una instancia o un set de réplicas de MongoDB.

La funcionalidad Stable API obliga al servidor a ejecutar operaciones con comportamientos compatibles con la versión de la API que especifiques. Al actualizar el controlador o el servidor, la versión de la API cambia, lo que puede afectar el comportamiento de estas operaciones. El uso de la API Estable garantiza respuestas coherentes del servidor y proporciona estabilidad a largo plazo de la API para tu aplicación.

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

Habilita la Stable API en un cliente de MongoDB

Para habilitar la Stable API, debes especificar una versión de la API en la configuración de tu cliente de MongoDB. Una vez que instancias una MongoClient instancia con una versión de la API especificada, todos los comandos que ejecutes con el cliente utilizarán esa versión de la Stable API.

Tip

Una vez que hayas creado un MongoClient, no podés cambiar su versión Stable API. Si debes ejecutar comandos usando más de una versión de la Stable API, debes instanciar un cliente separado con esa versión.

Si necesitas ejecutar comandos que no estén cubiertos por la Stable API, asegúrate de que la opción "estricta" esté desactivada. Consulte la sección sobre Opciones de Stable API para obtener más información.

El siguiente ejemplo muestra cómo puede instanciar un MongoClient con una Stable API versión y conectar a un servidor mediante 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 especificas una versión de API y te conectas a un servidor MongoDB que no admite la Stable API, tu código podría generar una excepción al ejecutar un comando en tu servidor MongoDB. Si se utiliza un MongoClient que especifica la versión de la API para query un servidor que no admite esa versión, la query podría fallar con un mensaje de excepción que incluya el siguiente texto:

Unrecognized field 'apiVersion' on server...

Opciones de Stable API

Puedes usar las opciones de la siguiente tabla para personalizar el comportamiento de la Stable API.

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 obsolescencia	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 se pueden configurar estas opciones al construir un objeto ServerApi:

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

Documentación de la API

Para más información sobre cómo usar la Stable API con el driver MongoDB .NET/C#, consulta la siguiente documentación de la API:

Volver

Personalizar selección de servidor

Pools de conexiones