MongoDB\Collection::withOptions()

Definición

MongoDB\Collection::withOptions()

Devuelve un clon del objeto Colección, pero con diferentes opciones.

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

Parámetros

$options : arreglo

Un arreglo 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 Collection utilizará el codificador por defecto. Nuevo en la versión 1.21.
códec	MongoDB\Codec\DocumentCodec	Por defecto codec que se utilizará para las operaciones de colección. Por defecto, se utiliza el códec de la colección original. Novedad en la versión 1.17.
readConcern	MongoDB\Driver\ReadConcern	El nivel de consistencia de lectura por defecto para usar en operaciones de colección. Por defecto, se aplica el nivel de consistencia de lectura de la colección original.
readPreference	MongoDB\Driver\ReadPreference	La preferencia de lectura por defecto para usar en las operaciones de colecciones. Por defecto, se utiliza la preferencia de lectura de la colección original.
typeMap	arreglo	El mapa de tipos para aplicar a cursores, que determina cómo se convierten los documentos BSON en valores PHP. De manera predeterminada, se utiliza el mapa de tipos de la colección original.
writeConcern	MongoDB\Driver\WriteConcern	El nivel de confirmación de escritura (write concern) por defecto que se usará para las operaciones de colección. Por defecto, utiliza el nivel de confirmación de escritura (write concern) de la colección original.

Return Values

Un objeto MongoDB\Collection.

Errores/Excepciones

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

Ejemplo

El siguiente ejemplo clona un objeto colección existente con una nueva preferencia de lectura:

<?php
$collection = (new MongoDB\Client)->selectCollection('test', 'restaurants');
$newCollection = $sourceCollection->withOptions([
    'readPreference' => new MongoDB\Driver\ReadPreference('primaryPreferred'),
]);

Ver también

• MongoDB\Collection::__construct()