/ /

Conectar

Docs Home

/ /

Driver de Java Reactive Streams

Conectar

Docs Home

Librerías de clientes

Java

Driver de Java Reactive Streams

Conectar

Stable API

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 habilitar y personalizar la API estable para su cliente MongoDB. Para obtener más información sobre la API estable, incluyendo una lista de los comandos que admite, consulte API estable en el manual del servidor MongoDB.

Activar la API estable

Para habilitar la API estable, realice los siguientes pasos:

Construir una ServerApi objeto y especifique una versión estable de la API. Debe usar una versión estable de la API definida en la enumeración ServerApiVersion.
Cree un objeto MongoClientSettings utilizando la clase MongoClientSettings.Builder.
Cree una instancia de MongoClient utilizando el método MongoClients.create() y pase su instancia de MongoClientSettings como parámetro.

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

ServerApi serverApi = ServerApi.builder()
        .version(ServerApiVersion.V1)
        .build();
// Replace the placeholder with your Atlas connection string
String uri = "<connection string URI>";
MongoClientSettings settings = MongoClientSettings.builder()
        .applyConnectionString(new ConnectionString(uri))
        .serverApi(serverApi)
        .build();
try (MongoClient mongoClient = MongoClients.create(settings)) {
    // Perform client operations here
}

Una vez creada una instancia MongoClient con la API estable, todos los comandos que ejecute con el cliente usarán la configuración de la API estable especificada. Si necesita ejecutar comandos con configuraciones alternativas, cree una nueva instancia MongoClient.

Configurar la API estable

La siguiente tabla describe los métodos encadenables de la clase ServerApi.Builder que puede utilizar para personalizar el comportamiento de la API estable.

Nombre de la opción	Descripción
`strict()`	Optional. When `true`, if you call a command that isn't part of the declared API version, the driver raises an exception. Default: false
`deprecationErrors()`	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 se puede configurar una instancia de ServerApi encadenando métodos en ServerApi.Builder:

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

Solución de problemas

Campo no reconocido 'apiVersion' en el servidor

El controlador Java Reactive Streams genera esta excepción si se especifica una versión de API y se conecta a un servidor MongoDB que no es compatible con la API estable. Asegúrese de conectarse a una implementación con MongoDB Server v5.0 o posterior.

Se proporcionó apiStrict:true, pero el comando <operation> no está en la versión API

El controlador Java Reactive Streams genera esta excepción si su MongoClient ejecuta una operación que no está en la versión de la API estable especificada. Para evitar este error, utilice una operación alternativa compatible con la versión de la API estable especificada o configure la opción strict como False al construir el objeto ServerApi.

Documentación de la API

Para obtener más información sobre el uso de la API estable con el controlador Java Reactive Streams, consulte la siguiente documentación de la API:

Volver

Comprimir el tráfico de la red

Bases de datos y colecciones