Stable API

Overview

En esta guía, puede aprender cómo especificar la Stable API al conectarse a una instancia de MongoDB o a un set de réplicas. Puedes usar la funcionalidad Stable API para forzar que el servidor ejecute 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 cambias a una versión diferente de la API, no se garantiza que las operaciones sean compatibles y no se garantiza que las respuestas del servidor sean similares.

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.

Consulta la página de referencia de MongoDB sobre la Stable API para obtener más información, incluida una lista 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.

Habilita la Stable API en un cliente de 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 se instancia una instancia de MongoClient con una versión de API especificada, todos los comandos que se ejecutan con ese cliente utilizan esa versión de la Stable API.

El siguiente ejemplo muestra cómo puedes crear una instancia de MongoClient que establezca la versión de la Stable API y se conecte a un servidor realizando las siguientes operaciones:

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

• Especifica una Stable API usando 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ónDelServidor

• MongoClientSettings

• MongoClientSettings.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 el 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, consulta la siguiente documentación de la API:

• estricto()

• deprecationErrors()