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 : 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 Collection utiliza el codificador predeterminado. Nuevo en la versión 1.21.
codec	MongoDB\Codec\DocumentCodec	El valor predeterminado Códec que se utilizará en las operaciones de recopilación. El valor predeterminado es el códec de la recopilación original. Nuevo en la versión 1.17.
readConcern	MongoDB\Driver\ReadConcern	La preocupación de lectura predeterminada para las operaciones de recopilación. El valor predeterminado es la preocupación de lectura de la recopilación original.
readPreference	MongoDB\Controlador\Preferencia de lectura	La preferencia de lectura predeterminada para las operaciones de recopilación. Se utiliza de forma predeterminada la preferencia de lectura de la recopilación 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 colección original.
writeConcern	MongoDB\Driver\WriteConcern	La preocupación de escritura predeterminada para las operaciones de recopilación. El valor predeterminado es la preocupación de escritura de la recopilación original.

Return Values

Un MongoDB\Collection 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 colección existente con una nueva preferencia de lectura:

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

Ver también

• MongoDB\Collection::__construct()