MongoDB\Collection::withOptions()
Definição
Parâmetros
$options
: arrayUma array especificando as opções desejadas.
NomeTipoDescriçãoCodecMongoDB\Codec\DocumentCodecOcodec padrão a ser usado em operações de collection. O padrão é o codec da coleção original.
Novidade na versão 1.17.
readConcernA read concern padrão a ser usada para operações de collection. O padrão é a preocupação de leitura da coleção original.readPreferenceA 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.typeMaparrayO mapa de tipos aplicar aos cursores, o que determina como os documentos BSON são convertidos em valores PHP. O padrão é o mapa de tipos da coleção original.writeConcernO 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:
$collection = (new MongoDB\Client)->selectCollection('test', 'restaurants'); $newCollection = $sourceCollection->withOptions([ 'readPreference' => new MongoDB\Driver\ReadPreference('primaryPreferred'), ]);