MongoDB\Client::selectCollection()

Definição

MongoDB\Client::selectCollection()

Seleciona uma collection no servidor. Esse método tem um nome alternativo por MongoDB\Client::getCollection() e será substituído por ele em uma versão futura.

function selectCollection(    string $databaseName,    string $collectionName,    array $options = []): MongoDB\Collection

Parâmetros

$databaseName : string

O nome do reconhecimento de data center que contém a collection a ser selecionada.

$collectionName : string

O nome da collection a ser selecionada.

$options : array

Uma array especificando as opções desejadas.

Nome	Tipo	Descrição
Codec	MongoDB\Codec\DocumentCodec	Os dados de codificação padrão com codecs de tipo a serem usados em operações de coleta. Novidades na versão 1.17.
readConcern	MongoDB\Driver\ReadConcern	O read concern padrão a ser usado para operações de collection. O padrão é a referência de leitura do cliente.
readPreference	MongoDB\Driver\ReadPreference	A preferência de leitura padrão a ser usada para operações de collection. O padrão é a preferência de leitura do cliente.
typeMap	array	O mapa de tipos padrão a ser usado para operações de collection. O padrão é o mapa de tipos do cliente.
writeConcern	MongoDB\Driver\WriteConcern	A referência de escrita padrão a ser usada em operações de collection. O padrão é a referência de escrita do cliente.

Return Values

Um objeto MongoDB\Collection .

Erros/exceções

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

Comportamento

A coleção selecionada herda opções como preferência de leitura e mapeamento de tipo do objeto Client. As opções podem ser substituídas utilizando o parâmetro $options.

Exemplo

O exemplo a seguir seleciona a collection users no reconhecimento de data center test :

<?php
$client = new MongoDB\Client;
$collection = $client->selectCollection('test', 'users');

O exemplo a seguir seleciona a collection users no reconhecimento de data center test com uma preferência de leitura personalizada:

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

Veja também

Voltar

removeSubscriber()

selectDatabase()