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
/ /
Conectar
Docs Home
/ /
Biblioteca PHP
/
Conectar
Docs Home
/
Librerías de clientes
/
PHP
/
Biblioteca PHP
/
Conectar

Especifica opciones de conexión

Overview

Esta página describe las opciones de conexión y autenticación de MongoDB disponibles en la librería PHP.

Configurar opciones de conexión

Puede configurar su conexión especificando opciones en el URI de conexión o pasándolas al constructor MongoDB\Client.

Uso del URI de conexión

Si pasas un URI de conexión al constructor de MongoDB\Client, puedes incluir opciones de conexión en el URI como pares <name>=<value>. En el siguiente ejemplo, el URI de conexión establece la opción tls en true y la opción tlsCertificateKeyFile en /path/to/file.pem:

// Replace the placeholders with your actual hostname, port, and path to the certificate key file
$uri = 'mongodb://<hostname>:<port>/?tls=true&tlsCertificateKeyFile=/path/to/file.pem';
// Create a MongoDB client
$client = new MongoDB\Client($uri);

Uso de un objeto MongoDB\Client

Puede pasar opciones de conexión al constructor MongoDB\Client en lugar de incluirlas en su URI de conexión.

El siguiente ejemplo muestra cómo usar el parámetro $uriOptions del constructor MongoDB\Client para establecer opciones de conexión:

// Replace the placeholders with your actual hostname and port
$uri = 'mongodb://<hostname>:<port>/';
// Set the connection options
// Replace the placeholder with the actual path to the certificate key file
$uriOptions = [
    'tls' => true,
    'tlsCertificateKeyFile' => '/path/to/file.pem',
];
// Create a MongoDB client with the URI and options
$client = new Client($uri, $uriOptions);

Nota

Si especificas una opción tanto en el parámetro $uriOptions como en la URI de conexión, el valor en $uriOptions tiene prioridad.

Opciones del URI de conexión

Las siguientes secciones describen las opciones que puedes configurar para tu conexión con MongoDB. Cada opción de conexión enlaza a su entrada correspondiente en el manual de MongoDB Server.

Importante

Codificación porcentaje

Si el valor de una opción de conexión contiene caracteres especiales, debes codificar en porcentaje el valor antes de incluirlo en el URI de conexión. Puedes utilizar el método rawurlencode() para codificar estos valores según la sintaxis URI especificada en RFC 3986.

No codifiques los signos de porcentaje en las opciones de conexión al incluirlas en el parámetro $uriOptions.

Para aprender más, consulta los siguientes recursos:

Opciones de set de réplicas

Opción de conexión
Descripción

directConnection

Tipo de datos: bool
Ejemplo de MongoDB\Client: $uriOptions = ['directConnection' => true];
Ejemplo de URI de conexión: directConnection=true

replicaSet

Tipo de datos: string
Ejemplo de MongoDB\Client: $uriOptions = ['replicaSet' => 'replicaSetName'];
Ejemplo de URI de conexión: replicaSet=replicaSetName

Opciones de conexión

Opciones de TLS

Para aprender sobre las opciones de TLS disponibles en la librería de PHP, consulte la página de TLS.

Opciones de tiempo de espera

Opción de conexión
Descripción

connectTimeoutMS

Tipo de datos: int
Ejemplo de MongoDB\Client: $uriOptions = ['connectTimeoutMS' => 2000];
Ejemplo de URI de conexión: connectTimeoutMS=2000

socketTimeoutMS

Tipo de datos: int
Ejemplo de MongoDB\Client: $uriOptions = ['socketTimeoutMS' => 20000];
Ejemplo de URI de conexión: socketTimeoutMS=20000

Opciones de compresión

Opción de conexión
Descripción

compresores

Tipo de datos: string
Ejemplo de MongoDB\Client: $uriOptions = ['compressors' => 'snappy,zstd,zlib'];
Ejemplo de URI de conexión: compressors=snappy,zstd,zlib

zlibCompressionLevel

Tipo de datos: int
Ejemplo de MongoDB\Client: $uriOptions = ['zlibCompressionLevel' => 3];
Ejemplo de URI de conexión: zlibCompressionLevel=3

Opciones de nivel de confirmación de escritura

Opción de conexión
Descripción

w

Tipo de datos: string
Ejemplo de MongoDB\Client: $uriOptions = ['w' => 'majority'];
Ejemplo de URI de conexión: w=majority

wTimeoutMS

Tipo de datos: int
Ejemplo de MongoDB\Client: $uriOptions = ['wTimeoutMS' => 10000];
Ejemplo de URI de conexión: wTimeoutMS=10000

journal

Tipo de datos: bool
Ejemplo de MongoDB\Client: $uriOptions = ['journal' => true];
Ejemplo de URI de conexión: journal=true

Opciones de readConcern

Opción de conexión
Descripción

readConcernLevel

Tipo de datos: string
Ejemplo de MongoDB\Client: $uriOptions = ['readConcernLevel' => 'majority'];
Ejemplo de URI de conexión: readConcernLevel=majority

Opciones de preferencia de lectura

Opción de conexión
Descripción

readPreference

Tipo de datos: MongoDB\Driver\ReadPreference
MongoDB\Client Ejemplo: $uriOptions = ['readPreference' => 'secondaryPreferred'];
Ejemplo de URI de conexión: readPreference=secondaryPreferred

maxStalenessSeconds

Tipo de datos: int
Ejemplo de MongoDB\Client: $uriOptions = ['maxStalenessSeconds' => 30];
Ejemplo de URI de conexión: maxStalenessSeconds=30

readPreferenceTags

Tipo de datos: array
Ejemplo de MongoDB\Client:

$uriOptions = [
    'readPreferenceTags' => [
        ['dc' => 'ny', 'rack' => 'r1'],
        [],
    ],
];

Ejemplo de URI de conexión: readPreferenceTags=dc:ny,rack:r1&readPreferenceTags=

Opciones de autenticación

Para aprender las opciones de autenticación disponibles en la librería PHP, consulta Mecanismos de autenticación.

Opciones de selección y descubrimiento de servidores

Opción de conexión
Descripción

localThresholdMS

Tipo de datos: int
Ejemplo de MongoDB\Client: $uriOptions = ['localThresholdMS' => 20];
Ejemplo de URI de conexión: localThresholdMS=20

serverSelectionTimeoutMS

Tipo de datos: int
Ejemplo de MongoDB\Client: $uriOptions = ['serverSelectionTimeoutMS' => 5000];
Ejemplo de URI de conexión: serverSelectionTimeoutMS=5000

serverSelectionTryOnce

Tipo de datos: bool
Ejemplo de MongoDB\Client: $uriOptions = ['serverSelectionTryOnce' => false];
Ejemplo de URI de conexión: serverSelectionTryOnce=false

heartbeatFrequencyMS

Tipo de datos: int
Ejemplo de MongoDB\Client: $uriOptions = ['heartbeatFrequencyMS' => 30000];
Ejemplo de URI de conexión: heartbeatFrequencyMS=30000

socketCheckIntervalMS

Tipo de datos: int
Ejemplo de MongoDB\Client: $uriOptions = ['socketCheckIntervalMS' => 4000];
Ejemplo de URI de conexión: socketCheckIntervalMS=4000

enableOverloadRetargeting

Tipo de datos: bool
Ejemplo de MongoDB\Client: $uriOptions = ['enableOverloadRetargeting' => true];
Ejemplo de URI de conexión: enableOverloadRetargeting=true

maxAdaptiveRetries

Tipo de datos: int
Ejemplo de MongoDB\Client: $uriOptions = ['maxAdaptiveRetries' => 3];
Ejemplo de URI de conexión: maxAdaptiveRetries=3

Varias configuraciones

Opción de conexión
Descripción

appName

Tipo de datos: string
Ejemplo de MongoDB\Client: $uriOptions = ['appName' => 'myApp'];
Ejemplo de URI de conexión: appName=myApp

retryReads

Tipo de datos: bool
Ejemplo de MongoDB\Client: $uriOptions = ['retryReads' => false];
Ejemplo de URI de conexión: retryReads=false

retryWrites

Tipo de datos: bool
Ejemplo de MongoDB\Client: $uriOptions = ['retryWrites' => false];
Ejemplo de URI de conexión: retryWrites=false

loadBalanced

Tipo de datos: bool
Ejemplo de MongoDB\Client: $uriOptions = ['loadBalanced' => true];
Ejemplo de URI de conexión: loadBalanced=true

srvMaxHosts

Tipo de datos: int
Ejemplo de MongoDB\Client: $uriOptions = ['srvMaxHosts' => 5];
Ejemplo de URI de conexión: srvMaxHosts=5

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\ReadPreference, consulte la siguiente documentación de la API de la extensión PHP:

Volver

Elija un destino de conexión

Next

Stable API

En esta página