Stable API

Overview

En esta guía, puedes aprender a especificar la compatibilidad de la API estable al conectarse a una implementación 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 puedes habilitar y personalizar Stable API para tu cliente de MongoDB. Para obtener más información sobre la Stable API, incluyendo una lista de los comandos que soporta, consulta Stable API en el manual del MongoDB Server.

Activar la API estable

Para habilitar la API Stable, realiza los siguientes pasos:

1. Construye un objeto ServerApi y especifica una versión de Stable API. Se debe utilizar una versión de API estable definida en el enum ServerApiVersion.

2. Construye un objeto MongoClient, pasando el objeto ServerApi para el argumento server_api.

El siguiente ejemplo de código muestra cómo especificar la versión 1 de Stable API. Seleccione la pestaña Synchronous o Asynchronous para ver el código correspondiente:

from pymongo import MongoClient
from pymongo.server_api import ServerApi
client = MongoClient("mongodb://<db_username>:<db_password>@<hostname:<port>",
                     server_api=ServerApi("1"))

from pymongo import AsyncMongoClient
from pymongo.server_api import ServerApi
client = AsyncMongoClient("mongodb://<db_username>:<db_password>@<hostname:<port>",
                          server_api=ServerApi("1"))

Una vez que creas una instancia de MongoClient con una versión de API especificada, todos los comandos que ejecutes con el cliente utilizan la versión especificada. Si necesitas ejecutar comandos utilizando más de una versión de la Stable API, crea una nueva MongoClient.

Configura la Stable API

La siguiente tabla describe los parámetros de la clase ServerApi. Se pueden usar estos parámetros para personalizar el comportamiento de la Stable API.

El siguiente ejemplo de código le muestra cómo puede utilizar estos parámetros al construir un objeto ServerApi. Selecciona la pestaña Synchronous o Asynchronous para ver el código correspondiente:

from pymongo import MongoClient
from pymongo.server_api import ServerApi
client = MongoClient("mongodb://<db_username>:<db_password>@<hostname:<port>",
                     server_api=ServerApi("1",
                     strict=True,
                     deprecation_errors=True))

from pymongo import AsyncMongoClient
from pymongo.server_api import ServerApi
client = AsyncMongoClient("mongodb://<db_username>:<db_password>@<hostname:<port>",
                          server_api=ServerApi("1",
                          strict=True,
                          deprecation_errors=True))

Solución de problemas

Documentación de la API

Para obtener más información sobre el uso de la Stable API con PyMongo, consulta la siguiente documentación de la API:

• MongoClient

• ServerApi

• ServerApiVersion