/ /

Stable API

Nota

La funcionalidad Stable API 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 Stable API obliga al servidor a ejecutar operaciones con comportamientos compatibles con la versión de la API que especifiques. Al actualizar el controlador o el servidor, la versión de la API cambia, lo que puede afectar el comportamiento de estas operaciones. El uso de la API Estable garantiza respuestas coherentes del servidor y proporciona 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:

Construya un objeto mongocxx::options::server_api y especifique una Stable API versión. Debe usar una Stable API definida en la enumeración mongocxx::options::server_api::version. Actualmente, el controlador solo admite la versión 1 (k_version_1).
Construir un objeto mongocxx::options::client. Establece el campo server_api_opts de este objeto en el objeto server_api que creaste en el paso anterior.
Cree un objeto mongocxx::client, ingresando su objeto mongocxx::uri y el objeto mongocxx::options::client que creó en el paso anterior.

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

#include <mongocxx/instance.hpp>
#include <mongocxx/uri.hpp>
#include <mongocxx/client.hpp>
int main()
{
    mongocxx::instance instance;
    mongocxx::uri uri("mongodb://<hostname>:<port>");
    mongocxx::options::server_api server_api_options(mongocxx::options::server_api::version::k_version_1);
    mongocxx::options::client client_options;
    client_options.server_api_opts(server_api_options);
    mongocxx::client client(uri, client_options);
}

Nota

Después de que crees una instancia de mongocxx::client con una versión de API especificada, todos los comandos que ejecutes con el cliente usarán la versión especificada. Si necesitas ejecutar comandos utilizando más de una versión de la Stable API, crea una nueva instancia mongocxx::client.

Configura la Stable API

La siguiente tabla describe las propiedades de la clase server_api_options. Puedes usar estas propiedades para personalizar el comportamiento de la Stable API.

Nombre de la opción	Descripción
estricto	Opcional. `true`Cuando, si se llama a un comando que no forma parte de la versión de API declarada, el controlador genera una excepción. Valor predeterminado: `false`
errores_de_uso_no_recomendado	Opcional. `true`Cuando, si se llama a un comando que está obsoleto en la versión de API declarada, el controlador genera una excepción. Valor predeterminado: `false`

El siguiente ejemplo de código muestra cómo puedes usar estos parámetros al construir un objeto ServerApi:

#include <mongocxx/instance.hpp>
#include <mongocxx/uri.hpp>
#include <mongocxx/client.hpp>
int main()
{
    mongocxx::instance instance;
    mongocxx::uri uri("mongodb://<hostname>:<port>");
    mongocxx::options::server_api server_api_options(mongocxx::options::server_api::version::k_version_1);
    server_api_options.strict(true);
    server_api_options.deprecation_errors(true);
    mongocxx::options::client client_options;
    client_options.server_api_opts(server_api_options);
    mongocxx::client client(uri, client_options);
}

Documentación de la API

Para obtener más información sobre el uso de la Stable API con el driver en C++, consulta la siguiente documentación de la API:

Volver

Comprimir el tráfico de la red

Pools de conexiones