Para agentes de IA: hay un índice de documentación disponible en https://www.mongodb.com/es/docs/llms.txt — versiones en markdown de todas las páginas están disponibles agregando .md a cualquier ruta URL.
Docs Menu
Docs Home
/ /
Opciones de conexión
Docs Home
/ /
Conectar
/
Opciones de conexión
Docs Home
/
Librerías de clientes
/
PHP
/
Biblioteca PHP
/
Conectar
/
Opciones de conexión

Conectarse con 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 de Stable API fuerza al servidor a ejecutar operaciones con comportamientos compatibles con la versión de la API que especifique. Cuando actualiza su versión de la librería o del servidor, cambia la versión de la API, lo que puede alterar el modo en que funcionan estas operaciones. Utilizar la Stable API garantiza respuestas coherentes del servidor y proporciona estabilidad API a largo plazo para la 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 MongoDB\Driver\ServerApi objeto y pasa la Stable API que deseas utilizar. Actualmente, la librería solo admite la versión 1.

  2. Construir un objeto MongoDB\Client. Para el parámetro driverOptions, pase un arreglo que contenga la opción serverApi. Configura esta opción con el objeto MongoDB\Driver\ServerApi que creaste 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

opcional. Cuando true, si llama a un comando que no forma parte de la versión de API declarada, el servidor genera una excepción.

Por defecto: null. Si este parámetro es nulo, el servidor aplica su valor por defecto de false.

errores de obsolescencia

Opcional. trueCuando, si se llama a un comando obsoleto en la versión de API declarada, el servidor genera una excepción.

Valornull predeterminado:. Si este parámetro es nulo, el servidor aplica su valor predeterminado false de.

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:

Volver

Opciones de conexión

Next

Comprimir el tráfico de la red

En esta página