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 función API estable obliga al servidor a ejecutar operaciones con comportamientos compatibles con la versión de API que especifique. Al actualizar el controlador o el servidor, la versión de API cambia, lo que puede modificar el comportamiento de estas operaciones. El uso de la API estable garantiza respuestas consistentes del servidor y proporciona estabilidad de API a largo plazo para su 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 mongoc_server_api_t objeto y especifique una versión estable de la API. Debe usar una versión estable de la API definida en la enumeración mongoc_server_api_t.
Construya un objeto mongoc_client_t.
Pase el cliente y el objeto API estable a la función mongoc_client_set_server_api.

El siguiente ejemplo de código muestra cómo especificar la versión de API estable 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 creada una instancia de cliente con una versión de API específica, todos los comandos que ejecute con el cliente usarán dicha versión. Si necesita ejecutar comandos con más de una versión de la API estable, cree un nuevo cliente.

Configurar la API estable

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

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 deprecación	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 puede 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 el uso de la API estable con el controlador C, consulte la siguiente documentación de la API:

Volver

Especifica opciones de conexión

Pools de conexiones