MongoDB\Database::withOptions()

Definição

MongoDB\Database::withOptions()

Retorna um clone do objeto de reconhecimento de data center, mas com opções diferentes.

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

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 Database utiliza o codificador padrão. Novidades na versão 1.21.:
readConcern	MongoDB\Driver\ReadConcern	A referência de leitura padrão a ser usada para operações de reconhecimento de data center. O padrão é a referência de leitura do reconhecimento de data center original.
readPreference	MongoDB\Driver\ReadPreference	A preferência de leitura padrão a ser usada para operações de banco de dados. O padrão é a preferência de leitura do banco de dados 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 do banco de dados original.
writeConcern	MongoDB\Driver\WriteConcern	A referência de escrita padrão a ser usada para operações de reconhecimento de data center. O padrão é a referência de escrita do reconhecimento de data center original.

Return Values

Um objeto MongoDB\Database .

Erros/exceções

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

Exemplo

O exemplo a seguir clona um reconhecimento de data center existente com uma nova preferência de leitura:

<?php
$db = (new MongoDB\Client)->test;
$newDb = $db->withOptions([
    'readPreference' => new MongoDB\Driver\ReadPreference('primaryPreferred'),
]);

Veja também

• MongoDB\Database::__construct()