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 : arreglo

Una matriz que especifica las opciones deseadas.

Nombre	Tipo	Descripción
builderEncoder	MongoDB\Codec\Encoder	El codificador utilizado para serializar tipos nativos de PHP a datos BSON en opciones de query y agregación. Si se omite, la instancia Database utilizará el codificador por defecto. Nuevo en la versión 1.21.
readConcern	MongoDB\Driver\ReadConcern	El nivel de consistencia de lectura por defecto a usar para las operaciones de la base de datos. De forma predeterminada, utiliza el nivel de consistencia de lectura de la base de datos original.
readPreference	MongoDB\Driver\ReadPreference	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 type map para aplicar a los cursores, lo que determina cómo se convierten los documentos BSON a valores PHP. Por defecto, se establece en el mapa de tipos de la base de datos original.
writeConcern	MongoDB\Driver\WriteConcern	El por defecto nivel de confirmación de escritura (write concern) a usar para las operaciones de base de datos. Por defecto, se utiliza el nivel de confirmación de escritura (write concern) de la base de datos original.

Return Values

A MongoDB\Database objeto.

Errores/Excepciones

MongoDB\Exception\InvalidArgumentException por 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()