Stable API

Overview

En esta guía, aprenderá a especificar la API estable al conectarse a una instancia o un conjunto de réplicas de MongoDB. Puede usar la función API estable para forzar al servidor a ejecutar operaciones con un comportamiento compatible con la versión de API especificada. Una versión de API define el comportamiento esperado de las operaciones que cubre y el formato de las respuestas del servidor. Si cambia a una versión de API diferente, no se garantiza la compatibilidad de las operaciones ni la similitud de las respuestas del servidor.

Cuando utiliza la función API estable con un controlador oficial de MongoDB, puede actualizar su controlador o servidor sin preocuparse por problemas de compatibilidad con versiones anteriores de los comandos cubiertos por la API estable.

Consulte la página de referencia de MongoDB en API estable para obtener más información, incluida una lista de comandos que cubre.

Las siguientes secciones describen cómo puede habilitar la API estable para su cliente MongoDB y las opciones que puede especificar.

Habilitar la API estable en un cliente MongoDB

Para habilitar la API estable, debe especificar una versión de API en el MongoClientOptions Se pasa a tu MongoClient. Una vez que creas una instancia MongoClient con una versión de API específica, todos los comandos que ejecutes con ese cliente usarán esa versión de la API estable.

El siguiente ejemplo muestra cómo puedes instanciar un MongoClient que establece la versión Stable API y se conecta a un servidor realizando las siguientes operaciones:

• Especifique una URI de servidor al cual conectarse.

• Especifique una versión de API estable en el objeto MongoClientOptions, utilizando una constante del objeto ServerApiVersion.

• Instancia un MongoClient, pasando el URI y el MongoClientOptions al constructor.

const { MongoClient, ServerApiVersion } = require("mongodb");
// Replace the placeholders in the connection string uri with your credentials
const uri = "mongodb+srv://<user>:<password>@<cluster-url>?retryWrites=true&w=majority";
// Create a client with options to specify Stable API Version 1
const client = new MongoClient(uri, { serverApi: ServerApiVersion.v1 });

MongoParseError: Invalid server API version=...

Para obtener más información sobre los métodos y clases mencionados en esta sección, consulta la siguiente documentación de la API:

• Versión de ServerApi

• MongoClientOptions

• MongoClient

Opciones de Stable API

Puede habilitar o deshabilitar el comportamiento opcional relacionado con la API estable como se describe en la siguiente tabla.

El siguiente ejemplo muestra cómo puedes configurar las opciones de la interfaz ServerApi.

const { MongoClient, ServerApiVersion } = require("mongodb");
// Replace the placeholders in the connection string uri with your credentials
const uri = "mongodb+srv://<user>:<password>@<cluster-url>?retryWrites=true&w=majority";
/* Create a client with options to specify Stable API Version 1, return
errors for commands outside of the API version, and raise exceptions
for deprecated commands */
const client = new MongoClient(uri,
    {
        serverApi: {
            version: ServerApiVersion.v1,
            strict: true,
            deprecationErrors: true,
        }
    });

Para obtener más información sobre las opciones de esta sección, consulte la siguiente documentación de API:

• Servidor API