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 la versión de la biblioteca o del servidor, la versión de la API cambia, lo que puede modificar el comportamiento de estas operaciones. Usar la API estable garantiza respuestas consistentes del servidor y proporciona estabilidad de la API a largo plazo para su 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
MongoDB\Driver\ServerApiObjeto y pasa la versión de la API estable que quieres usar. Actualmente, la biblioteca solo admite la versión 1.Construya un objeto
MongoDB\Client. Para el parámetrodriverOptions, pase una matriz que contenga la opciónserverApi. Establezca esta opción en el objetoMongoDB\Driver\ServerApique creó en el paso anterior.
El siguiente ejemplo de código muestra cómo especificar la versión Stable API 1:
$uri = 'mongodb://<hostname>:<port>'; $driverOptions = ['serverApi' => new MongoDB\Driver\ServerApi('1')]; $client = new MongoDB\Client($uri, [], $driverOptions);
Nota
Después de que crees una instancia de MongoDB\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 MongoDB\Client.
Configura la Stable API
El constructor MongoDB\Driver\ServerApi también acepta los siguientes parámetros opcionales. Se pueden usar estos parámetros para personalizar el comportamiento de la Stable API.
Parameter | Descripción |
|---|---|
estricto | Optional. When true, if you call a command that isn't part of
the declared API version, the server raises an exception.Default: null. If this parameter is null, the server applies its default
value of false. |
errores de obsolescencia | Optional. When true, if you call a command that is deprecated in the
declared API version, the server raises an exception.Default: null. If this parameter is null, the server applies its default
value of false. |
El siguiente ejemplo de código muestra cómo puedes usar estos parámetros al construir un objeto MongoDB\Driver\ServerApi:
$uri = 'mongodb://<hostname>:<port>'; $serverApi = new MongoDB\Driver\ServerApi('1', strict: true, deprecationErrors: true); $driverOptions = ['serverApi' => $serverApi]; $client = new MongoDB\Client($uri, [], $driverOptions);
Documentación de la API
Para obtener más información sobre la clase MongoDB\Client, consulta la siguiente documentación de la API de la biblioteca PHP:
Para obtener más información sobre la clase MongoDB\Driver\ServerApi, consulte la siguiente documentación de la API de la extensión PHP: