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 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
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 de API estable 1:
$uri = 'mongodb://<hostname>:<port>'; $driverOptions = ['serverApi' => new MongoDB\Driver\ServerApi('1')]; $client = new MongoDB\Client($uri, [], $driverOptions);
Nota
Después de crear una instancia MongoDB\Client 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 una nueva instancia MongoDB\Client.
Configurar la API estable
El constructor MongoDB\Driver\ServerApi también acepta los siguientes parámetros opcionales. Puedes usarlos para personalizar el comportamiento de la API estable.
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 desaprobación | 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 puede utilizar 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, consulte 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 extensión PHP: