/ /

/ /

Librerías de clientes

Driver C#/.NET

Fundamentals

Stable API

Nota

La función API estable requiere MongoDB Server 5.0 o posterior.

Debe utilizar la función API estable solo si todos los servidores MongoDB a los que se conecta admiten esta función.

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.

Habilitar la API estable en un cliente 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 puedes cambiar su Stable API versión. Si necesitas ejecutar comandos utilizando más de una versión de la Stable API, inicializa un cliente separado con esa versión.

Si necesita ejecutar comandos no contemplados por 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

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 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

MongoDB búsqueda

Autenticación