MongoDB\Client::selectCollection()

Definição

MongoDB\Client::selectCollection()

Seleciona uma collection no servidor.

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	Ocodec padrão a ser usado em operações de collection. Novidade 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 collection selecionada herda opções como preferência de leitura e mapeamento de tipo do objeto Client . As opções podem ser substituídas através do 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

• MongoDB\Collection::__construct()

• MongoDB\Database::selectCollection()