MongoDB\Database::withOptions()

Definición

MongoDB\Database::withOptions()

Devuelve un clon del objeto de base de datos, pero con diferentes opciones.

function withOptions(array $options = []): MongoDB\Database

Parámetros

$options : matriz

Una matriz que especifica las opciones deseadas.

Nombre	Tipo	Descripción
constructorEncoder	MongoDB\Codec\Encoder	El codificador utilizado para serializar tipos nativos de PHP a datos BSON en las opciones de consulta y agregación. Si se omite, la instancia Database utiliza el codificador predeterminado. Nuevo en la versión 1.21.
readConcern	MongoDB\Driver\ReadConcern	Preocupación de lectura predeterminada para operaciones de base de datos. El valor predeterminado es la preocupación de lectura de la base de datos original.
readPreference	MongoDB\Controlador\Preferencia de lectura	La preferencia de lectura por defecto que se utilizará para las operaciones en la base de datos. La preferencia de lectura por defecto es la preferencia de lectura de la base de datos original.
typeMap	arreglo	El mapa de tipos que se aplica a los cursores y que determina cómo se convierten los documentos BSON a valores PHP. El valor predeterminado es el mapa de tipos de la base de datos original.
writeConcern	MongoDB\Driver\WriteConcern	Preocupación de escritura predeterminada para operaciones de base de datos. El valor predeterminado es la preocupación de escritura de la base de datos original.

Return Values

A MongoDB\Database objeto.

Errores/Excepciones

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

Ejemplo

El siguiente ejemplo clona un objeto de base de datos existente con una nueva preferencia de lectura:

<?php
$db = (new MongoDB\Client)->test;
$newDb = $db->withOptions([
    'readPreference' => new MongoDB\Driver\ReadPreference('primaryPreferred'),
]);

Ver también

• MongoDB\Database::__construct()