MongoDB\Client::__construct()

Definición

MongoDB\Client::__construct()

Construye un nuevo Client instancia.

function __construct(
    ?string $uri = null,
    array $uriOptions = [],
    array $driverOptions = []
)

Parámetros

$uri : cadena

La cadena de conexión de MongoDB. Consulte Cadenas de conexión en el manual de MongoDB para obtener más información.

Por defecto es "mongodb://127.0.0.1:27017" si no se especifica.

Cualquier carácter especial en los componentes URI debe codificarse de acuerdo con RFC 3986Esto es especialmente relevante para el nombre de usuario y la contraseña, que a menudo pueden incluir caracteres especiales @ como, : %o. Al conectarse mediante un socket de dominio Unix, la ruta del socket puede contener caracteres especiales, como barras, y debe codificarse. La función rawurlencode() puede utilizarse para codificar las partes que componen el URI.

$uriOptions : arreglo

Especifica opciones adicionales de URI, como credenciales de autenticación o parámetros de cadena de consulta. Las opciones especificadas en $uriOptions prevalecen sobre cualquier opción análoga presente en la $uri cadena y no necesitan codificarse según 3986RFC.

Consulte la documentación de la extensión MongoDB\Driver\Manager::__construct() para obtener una lista de las opciones compatibles.

$driverOptions : arreglo

Especifica opciones específicas para el controlador PHP. Además de las opciones soportadas por la extensión, la librería también permite especificar un type map por defecto a aplicar a los cursores que crea.

Nombre	Tipo	Descripción
cifrado automático	arreglo	Opciones para configurar el cifrado a nivel de campo del lado del cliente en el controlador. Consulte la documentación de la extensión para obtener una lista de las opciones de cifrado compatibles. Si se proporciona un MongoDB\Client para la opción keyVaultClient, se desempaquetará como un MongoDB\driver\administrador para la extensión. Novedades en la versión 1.6.
controlador	arreglo	Metadatos adicionales del controlador que se transmitirán al protocolo de enlace del servidor. Se trata de una matriz que contiene los campos de cadena name, version y platform. Por ejemplo: [ 'name' => 'my-driver', 'version' => '1.2.3-dev', 'platform' => 'some-platform', ] Esta función está diseñada principalmente para controladores personalizados y ODM que deseen identificarse ante el servidor con fines de diagnóstico. Las aplicaciones que deseen identificarse deben usar la opción URI appName en lugar de esta opción. Novedades en la versión 1.7.
servidorAPI	MongoDB\Driver\ServerApi	Se utiliza para declarar una versión de la API en el cliente. Consulta la página API estable en el manual del servidor para obtener información adicional. Nuevo en la versión 1.9.
typeMap	arreglo	Mapa de tipo por defecto para aplicar a los cursores, que determina cómo se convierten los documentos BSON a valores de PHP. La librería utiliza el siguiente mapa de tipos por defecto: [ 'array' => 'MongoDB\Model\BSONArray', 'document' => 'MongoDB\Model\BSONDocument', 'root' => 'MongoDB\Model\BSONDocument', ]
constructorEncoder	MongoDB\Codec\Encoder	Codificador que se usará para los generadores de consultas y agregaciones. Si no se configura, esta opción toma como valor predeterminado una nueva instancia de la clase MongoDB\Builder\BuilderEncoder. Nuevo en la versión 1.21.
allow_invalid_hostname	booleano	Desactiva la validación del nombre de host si es true. El valor predeterminado es false. Permitir nombres de host no válidos puede exponer al controlador a un ataque del tipo "man-in-the-middle". Obsoleto desde la versión 1.6: Esta opción ha quedado obsoleta. Utilice la tlsAllowInvalidHostnames opción URI en su lugar.
ca_dir	string	Ruta a un directorio de certificados con el algoritmo hash correcto. Se utilizará el almacén de certificados del sistema por defecto. Vuelve a la opción de contexto SSL capath obsoleta si no se especifica.
archivo ca	string	Ruta a un archivo de autoridad de certificación. Se utilizará el almacén de certificados del sistema de forma predeterminada. Vuelve a la opción de contexto SSL cafile obsoleta si no se especifica. Obsoleto desde la versión 1.6: Esta opción ha quedado obsoleta. Utilice la tlsCAFile opción URI en su lugar.
archivo crl	string	Ruta a un archivo de lista de revocación de certificados.
archivo pem	string	Ruta a un certificado codificado PEM para utilizar en la autenticación del cliente. Vuelve a la opción de contexto SSL local_cert obsoleta si no se especifica. Obsoleto desde la versión 1.6: Esta opción ha quedado obsoleta. Utilice la tlsCertificateKeyFile opción URI en su lugar.
pem_pwd	string	Frase de contraseña para el certificado codificado PEM (si corresponde). Vuelve a la opción de contexto SSL passphrase obsoleta si no se especifica. Obsoleto desde la versión 1.6: Esta opción ha quedado obsoleta. Utilice la tlsCertificateKeyFilePassword opción URI en su lugar.
validación de certificado débil	booleano	Desactiva la validación del certificado true. El valor predeterminado es false. Vuelve a la opción de contexto SSL allow_self_signed obsoleta si no se especifica. Obsoleto desde la versión 1.6: Esta opción ha quedado obsoleta. Utilice la tlsAllowInvalidCertificates opción URI en su lugar.
context	resource	Opciones de contexto SSL que se usarán como respaldo para otras opciones del controlador (según se especifique). Tenga en cuenta que el controlador no consulta el contexto de flujo predeterminado. Esta opción se admite por compatibilidad con versiones anteriores, pero debe considerarse obsoleta.

Errores/Excepciones

MongoDB\Exception\InvalidArgumentException para errores relacionados con el análisis de parámetros u opciones.

MongoDB\Driver\Exception\InvalidArgumentException para errores relacionados con el análisis de parámetros u opciones en el nivel de extensión.

MongoDB\Driver\Exception\RuntimeException para otros errores en el nivel de extensión (por ejemplo, errores de conexión).

Comportamiento

Se construye internamente un MongoDB\driver\administrador. Según la spec de descubrimiento y supervisión de servidor, MongoDB\driver\Manager::__construct() no realiza entrada/salida. Las conexiones se inicializarán on-demand, cuando se ejecute la primera operación.

Ejemplos

<?php
$client = new MongoDB\Client('mongodb://mongodb-deployment:27017');

<?php
$client = new MongoDB\Client(
    'mongodb://rs1.example.com,rs2.example.com/?replicaSet=myReplicaSet',
    [
        'readPreference' => 'secondaryPreferred',
    ]
);

<?php
$client = new MongoDB\Client(
    'mongodb://myUsername:myPassword@rs1.example.com,rs2.example.com/?ssl=true&replicaSet=myReplicaSet&authSource=admin'
);

<?php
$client = new MongoDB\Client(
    'mongodb://rs1.example.com,rs2.example.com/'
    [
        'username' => 'myUsername',
        'password' => 'myPassword',
        'ssl' => true,
        'replicaSet' => 'myReplicaSet',
        'authSource' => 'admin',
    ],
);

<?php
$client = new MongoDB\Client(
    null,
    [],
    [
        'typeMap' => [
            'root' => 'array',
            'document' => 'array',
            'array' => 'array',
        ],
    ]
);

Ver también

• MongoDB\Driver\Manager::__construct()

• Formato de URI de cadena de conexión en el manual de MongoDB

• Servidor Descubrimiento y supervisión especificación