Conéctese con 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 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 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. Cree un objeto MongoClientSettings utilizando la clase MongoClientSettings.Builder.

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

El siguiente ejemplo de código muestra cómo especificar la versión Stable API 1:

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)

Una vez que crea una instancia de MongoClient con una versión de API especificada, todos los comandos que ejecute con el cliente usarán la versión especificada. Si debe ejecutar comandos usando más de una versión de la Stable API, cree un nuevo 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 muestra cómo puedes 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()

Solución de problemas

Documentación de la API

Para obtener más información sobre el uso de la Stable API con el controlador Kotlin Sync, consulte la siguiente documentación de API:

• ServerApi

• ServerApi.Builder

• ServerApiVersion

• DirecciónDelServidor

• MongoClientSettings

• MongoClientSettings.Builder

• MongoClient

• MongoClient.create()