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 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:

1. Construye un objeto mongoc_server_api_t y especifica una versión de Stable API. Se debe utilizar una versión de API estable definida en el enum mongoc_server_api_t.

2. Construya un objeto mongoc_client_t.

3. Pasa el cliente y el objeto de la Stable API a la función mongoc_client_set_server_api.

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

#include <mongoc/mongoc.h>
int main()
{
    bson_error_t error;
    mongoc_init();
    mongoc_server_api_t *stable_api = mongoc_server_api_new(MONGOC_SERVER_API_V1);
    mongoc_client_t *client = mongoc_client_new("<connection string>");
    if (!mongoc_client_set_server_api(client, stable_api, &error))
    {
        fprintf(stderr, "Failed to set Stable API: %s\n", error.message);
        return EXIT_FAILURE;
    }
    // Use the client for operations...
    mongoc_server_api_destroy(stable_api);
    mongoc_cleanup();
    return EXIT_SUCCESS;
}

Una vez que crees una instancia de cliente con una versión de API especificada, todos los comandos que ejecutes con el cliente utilizarán la versión especificada. Si tienes que ejecutar comandos utilizando más de una versión de la Stable API, crea un nuevo cliente.

Configura la Stable API

La siguiente tabla describe las opciones de la clase ServerApi. Puede usar estas opciones para personalizar el comportamiento de la Stable API.

El siguiente ejemplo de código muestra cómo puedes establecer ambas opciones en true al construir un objeto ServerApi:

mongoc_server_api_t *stable_api = mongoc_server_api_new(MONGOC_SERVER_API_V1);
mongoc_server_api_strict(stable_api, true);
mongoc_server_api_deprecation_errors(stable_api, true);
mongoc_client_t *client = mongoc_client_new("<connection string>");
if (!mongoc_client_set_server_api(client, stable_api, &error)) {
    fprintf(stderr, "Failed to set Stable API: %s\n", error.message);
    return EXIT_FAILURE;
}

Documentación de la API

Para obtener más información sobre cómo usar la Stable API con el driver C, consulta la siguiente documentación de la API:

• mongoc_server_api_t

• mongoc_server_api_version_t

• mongoc_server_api_new

• mongoc_client_t