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 utilices la funcionalidad Stable API con un driver oficial de MongoDB, podrás actualizar tu driver o servidor sin preocuparte por problemas de retrocompatibilidad de los comandos cubiertos por la Stable API.

Consulte la página de referencia de MongoDB en Stable API para más información, incluido un listado de los comandos que cubre.

Las siguientes secciones describen cómo se puede habilitar la Stable API para el cliente de MongoDB y las opciones que se pueden especificar.

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 API especificada, todos los comandos que ejecutes con ese cliente utilizan esa versión de la API estable.

El siguiente ejemplo muestra cómo se puede crear una instancia de MongoClient que establece la versión de API estable y se conecta a un servidor realizando las siguientes operaciones:

• Construya una instancia ServerApi usando la clase asistente ServerApi.Builder.

• Especifique una versión de API estable utilizando una constante de la clase ServerApiVersion.

• Construir una instancia de MongoClientSettings usando la clase MongoClientSettings.Builder.

• Especifique un servidor al que conectarse usando una instancia de ServerAddress.

• Instancia un MongoClient usando el método MongoClient.create() y pasa tu instancia MongoClientSettings como parámetro.

val serverApi = ServerApi.builder()
    .version(ServerApiVersion.V1)
    .build()
// Replace the uri string placeholder with your MongoDB deployment's connection string
val uri = "<connection string>"
val settings = MongoClientSettings.builder()
    .applyConnectionString(ConnectionString(uri))
    .serverApi(serverApi)
    .build()
val client = MongoClient.create(settings)

'Unrecognized field 'apiVersion' on server...

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:

• ServerApi

• ServerApi.Builder

• ServerApiVersion

• Dirección del servidor

• MongoClientSettings

• Configuración del cliente de Mongo.Builder

• MongoClient.create()

• MongoClient

Opciones de Stable API

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

El siguiente ejemplo muestra cómo se pueden establecer las dos opciones en una instancia de ServerApi encadenando métodos en ServerApi.Builder:

val serverApi = ServerApi.builder()
    .version(ServerApiVersion.V1)
    .strict(true)
    .deprecationErrors(true)
    .build()

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

• estricto()

• deprecationErrors()