MongoDB\Collection::withOptions()

Definição

MongoDB\Collection::withOptions()

Retorna um clone do objeto Collection, mas com opções diferentes.

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

Parâmetros

$options : array

Uma array especificando as opções desejadas.

Nome	Tipo	Descrição
builderEncoder	MongoDB\Codec\Encoder	O codificador usado para serializar tipos PHP nativos para dados BSON em opções de query e agregação . Se omitido, a instância do Collection utiliza o codificador padrão. Novidades na versão 1.21.:
Codec	MongoDB\Codec\DocumentCodec	O codec padrão a ser usado em operações de collection. O padrão é o codec da coleção original. Novidades na versão 1.17.:
readConcern	MongoDB\Driver\ReadConcern	A read concern padrão a ser usada para operações de collection. O padrão é a preocupação de leitura da coleção original.
readPreference	MongoDB\Driver\ReadPreference	A preferência de leitura padrão a ser usada para operações de coleta. O padrão é a preferência de leitura da coleção original.
typeMap	array	O mapa de tipo a aplicar aos cursores, que determina como os documentos BSON são convertidos em valores PHP. O padrão é o mapa de tipos da coleção original.
writeConcern	MongoDB\Driver\WriteConcern	O write concern padrão a ser usado para operações de coleta. O padrão é a write concern da coleção original.

Return Values

Um objeto MongoDB\Collection .

Erros/exceções

MongoDB\Exception\InvalidArgumentException para erros relacionados à análise de parâmetros ou opções.

Exemplo

O exemplo a seguir clona um objeto Collection existente com uma nova read preference:

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

Veja também

• MongoDB\Collection::__construct()