Nota
La función API estable 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 se puede habilitar y personalizar la Stable API para su cliente de MongoDB. Para obtener más información sobre la Stable API, incluida una lista de los comandos que admite, consulta API estable en el manual del servidor MongoDB.
Activar la API estable
Para habilitar la API Stable, realiza los siguientes pasos:
Construir un
ServerApiobjeto y especificar una versión de Stable API. Debe utilizar una versión de Stable API definida en el enumServerApiVersion.Cree un objeto
MongoClientSettingsutilizando la claseMongoClientSettings.Builder.Instancia un
MongoClientusando el métodoMongoClient.create()y pasa tu instanciaMongoClientSettingscomo 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.
Nombre de la opción | Descripción |
|---|---|
estricto | Optional. When True, if you call a command that isn't part of
the declared API version, the driver raises an exception.Default: False |
errores de obsolescencia | Optional. When True, if you call a command that is deprecated in the
declared API version, the driver raises an exception.Default: False |
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
Campo no reconocido 'apiVersion' en el servidor
El driver de Kotlin Sync genera esta excepción si se especifica una versión de API y se conecta a un servidor MongoDB que no soporta la Stable API. Asegúrese de conectarse a una implementación que ejecute MongoDB Server v5.0 o posterior.
Se proporcionó apiStrict:true, pero el conteo de comandos no está en la Versión API
El driver de sincronizar de Kotlin genera esta excepción si tu MongoClient ejecuta una operación que no se encuentra en la versión de 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 a False al construir tu objeto ServerApi.
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: