MongoDB\Driver\Manager::__construct

Parámetros

uri

Una URI de conexión » mongodb://:

mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[defaultAuthDb][?options]]

Para los detalles sobre las opciones de URI admitidas, ver » Opciones de cadena de conexión en el manual MongoDB. » Opciones de pool de conexiones no son admitidas, ya que la extensión no implementa pools de conexiones.

Por omisión, "mongodb://127.0.0.1:27017" si no se especifica.

El uri es una URL, por lo que todos los caracteres especiales en sus componentes deben estar codificados en URL según la » RFC 3986. Esto es particularmente relevante para el nombre de usuario y la contraseña, que pueden incluir caracteres especiales tales como @, : o %. Al conectarse a través de un socket de dominio Unix, la ruta del socket puede contener caracteres especiales como barras diagonales y debe estar codificada. La función rawurlencode() puede ser utilizada para codificar las partes constitutivas de la URI.

El componente defaultAuthDb puede ser utilizado para especificar la base de datos asociada a las credenciales del usuario; sin embargo, la opción de URI authSource tendrá prioridad si se especifica. Si ni defaultAuthDb ni authSource se especifican, la base de datos admin será utilizada por omisión. El componente defaultAuthDb no tiene ningún efecto en ausencia de credenciales de usuario.

uriOptions

Opciones adicionales » de cadena de conexión, que sobrescribirán cualquier opción con el mismo nombre en el parámetro uri.

uriOptions

Opción	Tipo	Descripción
appname	string	MongoDB 3.4+ tiene la capacidad de anotar las conexiones con metadatos proporcionados por el cliente conectado. Estos metadatos se incluyen en los registros del servidor al establecer una conexión y también se registran en los registros de consultas lentas cuando el perfilado de la base de datos está activado. Esta opción puede ser utilizada para especificar un nombre de aplicación, que será incluido en los metadatos. El valor no puede exceder 128 caracteres de longitud.
authMechanism	string	El mecanismo de autenticación que MongoDB utilizará para autenticar la conexión. Para más detalles y una lista de los valores admitidos, ver » Opciones de autenticación en el manual MongoDB.
authMechanismProperties	array	Las propiedades específicas del mecanismo de autenticación seleccionado. Para más detalles y una lista de las propiedades admitidas, ver la » Especificación de autenticación del controlador. Nota: Cuando no se especifica en la cadena de URI, esta opción se expresa como un array de pares clave/valor. Las claves y valores de este array deben ser strings.
authSource	string	El nombre de la base de datos asociada a las credenciales del usuario. Por omisión al componente de la base de datos de la URI de conexión, o a la base de datos admin si ambos no se especifican. Para los mecanismos de autenticación que no admiten la noción de base de datos (por ejemplo, GSSAPI), esto debería ser "$external".
compressors	string	Una lista priorizada y delimitada por comas de compresores que el cliente desea utilizar. Los mensajes solo se comprimen si el cliente y el servidor comparten compresores en común, y el compresor utilizado en cada dirección dependerá de la configuración individual del servidor o del controlador. Ver la » Especificación de compresión del controlador para más información.
connectTimeoutMS	int	El tiempo en milisegundos para intentar una conexión antes de expirar. Por omisión, 10 000 milisegundos.
directConnection	bool	Esta opción puede ser utilizada para controlar el comportamiento de descubrimiento del conjunto de réplicas cuando solo se proporciona un host en la cadena de conexión. Por omisión, proporcionar un solo miembro en la cadena de conexión establecerá una conexión directa o descubrirá miembros adicionales según si la opción de URI "replicaSet" está omitida o presente, respectivamente. Especifique false para forzar el descubrimiento a que ocurra (si "replicaSet" está omitido) o especifique true para forzar una conexión directa (si "replicaSet" está presente).
heartbeatFrequencyMS	int	Especifica el intervalo en milisegundos entre las verificaciones de la topología MongoDB, contado desde el final de la verificación previa hasta el inicio de la siguiente. Por omisión, 60 000 milisegundos. Para la » Especificación de descubrimiento y supervisión del servidor, este valor no puede ser inferior a 500 milisegundos.
journal	bool	Corresponde a la opción journal del write concern por omisión. Si true, las escrituras requerirán un acuse de recibo de MongoDB indicando que la operación ha sido escrita en el diario. Para más detalles, ver MongoDB\Driver\WriteConcern.
loadBalanced	bool	Especifica si el controlador se conecta a un clúster MongoDB a través de un equilibrador de carga. Si true, el controlador solo puede conectarse a un solo host (especificado por la cadena de conexión o la búsqueda SRV), la opción de URI "directConnection" no puede ser true, y la opción de URI "replicaSet" debe ser omitida. Por omisión, false.
localThresholdMS	int	El tamaño en milisegundos de la ventana de latencia para la selección entre múltiples instancias MongoDB apropiadas al resolver una preferencia de lectura. Por omisión, 15 milisegundos.
maxStalenessSeconds	int	Corresponde a la opción maxStalenessSeconds de la preferencia de lectura. Especifica, en segundos, la duración máxima de validez de una instancia secundaria antes de que el cliente deje de usarla para las operaciones de lectura. Por omisión, no hay una duración máxima de validez y los clientes no tendrán en cuenta el retraso de una instancia secundaria al elegir la dirección de una operación de lectura. Para más detalles, ver MongoDB\Driver\ReadPreference. Si se especifica, la duración máxima de validez debe ser un entero de 32 bits firmado superior o igual a MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS (por ejemplo, 90 segundos).
password	string	La contraseña del usuario en proceso de autenticación. Esta opción es útil si la contraseña contiene caracteres especiales, que de otro modo deberían estar codificados en URL para la URI de conexión.
readConcernLevel	string	Corresponde a la opción level de la preferencia de lectura. Especifica el nivel de aislamiento de lectura. Para más detalles, ver MongoDB\Driver\ReadConcern.
readPreference	string	Corresponde a la opción mode de la preferencia de lectura. Por omisión, "primary". Para más detalles, ver MongoDB\Driver\ReadPreference.
readPreferenceTags	array	Corresponde a la opción tagSets de la preferencia de lectura. Los conjuntos de etiquetas permiten dirigir las operaciones de lectura a miembros específicos de un conjunto de réplicas. Para más detalles, ver MongoDB\Driver\ReadPreference. Nota: Cuando no se especifica en la cadena de URI, esta opción se expresa como un array conforme al formato esperado por MongoDB\Driver\ReadPreference::__construct().
replicaSet	string	Especifica el nombre del conjunto de réplicas.
retryReads	bool	Especifica si el controlador debe reintentar automáticamente ciertas operaciones de lectura que fallan debido a errores de red transitorios o elecciones de conjunto de réplicas. Esta funcionalidad requiere MongoDB 3.6+. Por omisión, true. Ver la » Especificación de lectura reintentable para más información.
retryWrites	bool	Especifica si el controlador debe reintentar automáticamente ciertas operaciones de escritura que fallan debido a errores de red transitorios o elecciones de conjunto de réplicas. Esta funcionalidad requiere MongoDB 3.6+. Por omisión, true. Ver » Escrituras reintentables en el manual MongoDB para más información.
serverSelectionTimeoutMS	int	Especifica cuánto tiempo en milisegundos bloquear para la selección del servidor antes de lanzar una excepción. Por omisión, 30 000 milisegundos.
serverSelectionTryOnce	bool	Cuando true, indica al controlador que escanee el despliegue MongoDB exactamente una vez después de un fallo de selección del servidor, luego seleccione un servidor o lance una excepción. Cuando false, el controlador bloquea y busca un servidor hasta el valor de "serverSelectionTimeoutMS". Por omisión, true.
socketCheckIntervalMS	int	Si un socket no ha sido utilizado recientemente, el controlador debe verificarlo a través de un comando hello antes de usarlo para cualquier operación. Por omisión, 5 000 milisegundos.
socketTimeoutMS	int	El tiempo en milisegundos para intentar un envío o recepción en un socket antes de expirar. Por omisión, 300 000 milisegundos (es decir, cinco minutos).
srvMaxHosts	int	El número máximo de resultados SRV a seleccionar aleatoriamente durante la primera población de la lista de semillas o, durante la consulta SRV, la adición de nuevos hosts a la topología. Por omisión, 0 (es decir, sin máximo).
srvServiceName	string	El nombre de servicio a utilizar para la búsqueda SRV en la lista de semillas inicial y la consulta SRV. Por omisión, "mongodb".
tls	bool	Inicializa la conexión con TLS/SSL si true. Por omisión, false.
tlsAllowInvalidCertificates	bool	Especifica si el controlador debe generar un error cuando el certificado TLS del servidor es inválido. Por omisión, false. Advertencia Desactivar la validación del certificado crea una vulnerabilidad.
tlsAllowInvalidHostnames	bool	Especifica si el controlador debe generar un error cuando hay un desacuerdo entre el nombre de host del servidor y el nombre de host especificado por el certificado TLS. Por omisión, false. Advertencia Desactivar la validación del certificado crea una vulnerabilidad. Permitir nombres de host inválidos puede exponer al controlador a una » ataque del hombre del medio.
tlsCAFile	string	La ruta del archivo que contiene un solo certificado o un conjunto de certificados de autoridades a considerar confiables al establecer una conexión TLS. Se utilizará el almacén de certificados del sistema por omisión.
tlsCertificateKeyFile	string	La ruta del archivo de certificado del cliente o del archivo de clave privada del cliente; en el caso de que ambos sean necesarios, los archivos deben estar concatenados.
tlsCertificateKeyFilePassword	string	La contraseña para descifrar la clave privada del cliente (es decir, la opción de URI "tlsCertificateKeyFile") a utilizar para las conexiones TLS.
tlsDisableCertificateRevocationCheck	bool	Si true, el controlador no intentará verificar el estado de revocación del certificado (por ejemplo, OCSP, CRL). Por omisión, false.
tlsDisableOCSPEndpointCheck	bool	Si true, el controlador no intentará contactar un punto de extremo de responso OCSP si es necesario (es decir, una respuesta OCSP no está grapada). Por omisión, false.
tlsInsecure	bool	Relaja las restricciones TLS tanto como sea posible. Especificar true para que esta opción tenga el mismo efecto que especificar true para las opciones de URI "tlsAllowInvalidCertificates" y "tlsAllowInvalidHostnames". Por omisión, false. Advertencia Desactivar la validación del certificado crea una vulnerabilidad. Permitir nombres de host inválidos puede exponer al controlador a una » ataque del hombre del medio.
username	string	El nombre de usuario del usuario en proceso de autenticación. Esta opción es útil si el nombre de usuario contiene caracteres especiales, que de otro modo deberían estar codificados en URL para la URI de conexión.
w	int|string	Corresponde a la opción w del write concern por omisión. Para más detalles, ver MongoDB\Driver\WriteConcern.
wTimeoutMS	int|string	Corresponde a la opción wtimeout del write concern por omisión. Especifica un límite de tiempo, en milisegundos, para el write concern. Para más detalles, ver MongoDB\Driver\WriteConcern. Si se especifica, wTimeoutMS debe ser un entero de 32 bits firmado superior o igual a cero.
zlibCompressionLevel	int	Especifica el nivel de compresión a utilizar para el compresor zlib. Esta opción no tiene ningún efecto si zlib no está incluido en la opción de URI "compressors". Ver la » Especificación de compresión del controlador para más información.

driverOptions

driverOptions

Opción	Tipo	Descripción
autoEncryption	array	Proporciona opciones para activar el cifrado automático a nivel de campo. La lista de opciones se describe en la tabla de abajo. Nota: El cifrado automático es una funcionalidad empresarial que solo se aplica a las operaciones sobre una colección. El cifrado automático no es admitido para las operaciones sobre una base de datos o una vista, y las operaciones que no son sorteadas resultarán en un error (ver » libmongocrypt: La lista de autorización de cifrado automático). Para sortear el cifrado automático para todas las operaciones, establezca bypassAutoEncryption a true. El cifrado automático requiere que el usuario autenticado tenga el privilegio de acción » listCollections. El cifrado explícito y automático es una funcionalidad de la comunidad. El controlador siempre puede descifrar automáticamente cuando bypassAutoEncryption es true.
ca_dir	string	La ruta del directorio de certificados correctamente hashados. Se utilizará el almacén de certificados del sistema por omisión.
crl_file	string	La ruta del archivo de lista de revocación de certificados.
disableClientPersistence	bool	Si true, este Manager utilizará un nuevo cliente libmongoc, que no será persistido ni compartido con otros objetos Manager. Cuando este objeto Manager es liberado, su cliente será destruido y todas las conexiones serán cerradas. Por omisión, false. Nota: Desactivar la persistencia del cliente no es generalmente recomendado.
driver	array	Permite a un nivel superior de biblioteca añadir sus propias metadatos al apretón de manos del servidor. Por omisión, la extensión envía su propio nombre, versión y plataforma (es decir, versión PHP) en el apretón de manos. Las cadenas pueden ser especificadas para las claves "name", "version" y "platform" de este array, y serán añadidas al campo respectivo(s) del apretón de manos del servidor. Nota: Las informaciones del apretón de manos están limitadas a 512 bytes. La extensión truncará los datos del apretón de manos para adaptarse a esta cadena de 512 bytes. Las bibliotecas de nivel superior están animadas a mantener sus propias metadatos concisas.
serverApi	MongoDB\Driver\ServerApi	Esta opción se utiliza para declarar una versión de API de servidor para el Manager. Si se omite, no se declara ninguna versión de API.

Las siguientes opciones son admitidas:

Opciones para el cifrado automático

Opción	Tipo	Descripción
keyVaultClient	MongoDB\Driver\Manager	El Manager utilizado para enrutar las peticiones de claves de datos a un cluster MongoDB diferente. Por omisión, el Manager y cluster actual es utilizado.
keyVaultNamespace	string	Un nombre de espacio completamente calificado (por ejemplo "databaseName.collectionName") denotando la colección que contiene todas las claves de datos utilizadas para el cifrado y descifrado. Esta opción es requerida.
kmsProviders	array	Un documento que contiene la configuración de uno o varios proveedores KMS, que se utilizan para cifrar las claves de datos. Los proveedores soportados son "aws", "azure", "gcp" y "local", y al menos uno debe ser especificado. Si se especifica un documento vacío para "aws", "azure", o "gcp", el controlador intentará configurar el proveedor utilizando » Automatic Credentials. El formato para "aws" es el siguiente : aws: { accessKeyId: <string>, secretAccessKey: <string>, sessionToken: <optional string> } El formato para "azure" es el siguiente : azure: { tenantId: <string>, clientId: <string>, clientSecret: <string>, identityPlatformEndpoint: <optional string> // Defaults to "login.microsoftonline.com" } El formato para "gcp" es el siguiente : gcp: { email: <string>, privateKey: <base64 string>|<MongoDB\BSON\Binary>, endpoint: <optional string> // Defaults to "oauth2.googleapis.com" } El formato para "kmip" es el siguiente : kmip: { endpoint: <string> } El formato para "local" es el siguiente : local: { // 96-byte master key used to encrypt/decrypt data keys key: <base64 string>|<MongoDB\BSON\Binary> }
tlsOptions	array	Un documento que contiene la configuración TLS de uno o varios proveedores KMS. Los proveedores soportados son "aws", "azure", "gcp" y "kmip". Todos los proveedores soportan las siguientes opciones : <provider>: { tlsCaFile: <optional string>, tlsCertificateKeyFile: <optional string>, tlsCertificateKeyFilePassword: <optional string>, tlsDisableOCSPEndpointCheck: <optional bool> }
schemaMap	array|object	Mapea los espacios de nombres de colección a un esquema JSON local. Esto se utiliza para configurar el cifrado automático. Ver » Reglas de cifrado automático en el manual MongoDB para más información. Es un error especificar una colección tanto en schemaMap como en encryptedFieldsMap. Nota: Proporcionar un schemaMap proporciona más seguridad que confiar en los esquemas JSON obtenidos del servidor. Esto protege contra un servidor malintencionado anunciando un falso esquema JSON, que podría engañar al cliente para enviar datos no cifrados que deberían estar cifrados. Nota: Los esquemas proporcionados en el schemaMap solo se aplican a la configuración del cifrado automático para el cifrado del lado del cliente. Otras reglas de validación en el esquema JSON no serán aplicadas por el controlador y resultarán en un error.
bypassAutoEncryption	bool	Si true, mongocryptd no será lanzado automáticamente. Esto se utiliza para desactivar el cifrado automático. Por omisión, false.
bypassQueryAnalysis	bool	Si true, el análisis automático de las comandos salientes será desactivado y mongocryptd no será lanzado automáticamente. Esto permite el caso de uso del cifrado explícito para consultar campos indexados sin requerir la biblioteca crypt_shared bajo licencia empresarial o el proceso mongocryptd. Por omisión, false.
encryptedFieldsMap	array|object	Mapea los espacios de nombres de colección a un documento encryptedFields. Esto se utiliza para configurar el cifrado consultable. Ver » Cifrado de campo y consultabilidad en el manual MongoDB para más información. Es un error especificar una colección tanto en encryptedFieldsMap como en schemaMap. Nota: Proporcionar un encryptedFieldsMap proporciona más seguridad que confiar en los encryptedFields obtenidos del servidor. Esto protege contra un servidor malintencionado anunciando un falso encryptedFields.
extraOptions	array	El extraOptions se refieren al proceso mongocryptd. Las siguientes opciones son admitidas: mongocryptdURI (string): URI para conectarse a un proceso mongocryptd existente. Por omisión, "mongodb://localhost:27020". mongocryptdBypassSpawn (bool): Si true, impide que el controlador lance mongocryptd. Por omisión, false. mongocryptdSpawnPath (string): Ruta absoluta para buscar el binario mongocryptd. Por omisión, una cadena vacía y consulta las rutas del sistema. mongocryptdSpawnArgs (array): Array de argumentos de cadena a pasar a mongocryptd al lanzarlo. Por omisión, ["--idleShutdownTimeoutSecs=60"]. cryptSharedLibPath (string): Ruta absoluta hacia la biblioteca compartida crypt_shared. Por omisión, una cadena vacía y consulta las rutas del sistema. cryptSharedLibRequired (bool): Si true, exige que el controlador cargue crypt_shared. Por omisión, false. Ver la » Especificación de cifrado del lado del cliente para más información.

Nota: El cifrado automático es una funcionalidad empresarial que solo se aplica a las operaciones sobre una colección. El cifrado automático no es admitido para las operaciones sobre una base de datos o una vista, y las operaciones que no son sorteadas resultarán en un error. Para sortear el cifrado automático para todas las operaciones, establezca bypassAutoEncryption=true en autoEncryption. Para más información sobre las operaciones admitidas, ver la » Especificación de cifrado del lado del cliente.