Nota
La funcionalidad Stable API requiere MongoDB Server 5.0 o posterior.
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 de Stable API obliga al servidor a ejecutar operaciones con comportamientos compatibles con la versión de API que especifique. El uso de la Stable API garantiza respuestas coherentes del servidor y proporciona una estabilidad a largo plazo de la API para tu aplicación.
Las siguientes secciones describen cómo puedes habilitar y personalizar la 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 activar la Stable API, se debe pasar un hash que especifique la versión de la Stable API al parámetro opcional server_api al crear una instancia Mongo::Client.
El siguiente ejemplo de código muestra cómo especificar la versión Stable API 1:
client = Mongo::Client.new(uri, server_api: { version: '1' })
Una vez que creas una instancia de Client con una versión de API especificada, todos los comandos que ejecutes con el cliente usarán la versión especificada. Si debes ejecutar comandos utilizando más de una versión de la Stable API, crea una nueva Client.
Configura la Stable API
La siguiente tabla describe las opciones de Stable API que puedes configurar especificándolas en el hash server_api. Puedes usar estas opciones para personalizar el comportamiento de la Stable API.
Nombre de la opción | Descripción |
|---|---|
estricto | opcional. Cuando |
errores_de_uso_no_recomendado | Opcional. Cuando, |
El siguiente ejemplo de código muestra cómo puedes establecer las dos opciones en una instancia de ServerApi:
client = Mongo::Client.new(uri, server_api: { version: '1', strict: true, deprecation_errors: true })
Solución de problemas
Las siguientes secciones describen problemas comunes que se pueden encontrar al usar Stable API.
Campo no reconocido 'apiVersion' en el servidor
El driver de Ruby genera esta excepción si especificas una versión de la API y te conectas a un servidor de MongoDB que no admite la Stable API. Asegúrate de estar conectándote a una implementación que ejecute el servidor de MongoDB v5.0 o posterior.
Se proporcionó apiStrict:true, pero el conteo de comandos no está en la Versión API
El driver de Ruby genera esta excepción si tu Client ejecuta una operación que no está en la Stable API que especificaste. Para evitar este error, utiliza una operación alternativa compatible con la versión de la Stable API especificada o configura la opción strict en false al construir tu objeto ServerApi.
Documentación de la API
Para obtener más información sobre cómo usar la Stable API con el driver de Ruby, consulta la siguiente documentación de la API: