MongoDB\Database::getCollection()

Nesta página

Definição

Parâmetros
Return Values
Erros/exceções
Comportamento
Exemplo
Veja também

Definição

MongoDB\Database::getCollection()

Obtém acesso a uma collection dentro do banco de dados. Este método é um alias para MongoDB\Database::selectCollection() e o substituirá em uma versão futura.

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

Parâmetros

$collectionName : string

O nome da collection a ser acessada.

$options : array

Uma array especificando as opções desejadas.

Nome	Tipo	Descrição
Codec	MongoDB\Codec\DocumentCodec	O codec 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 preocupação de leitura do banco de dados.
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 banco de dados.
typeMap	array	O mapa de tipos padrão a ser usado para operações de collection. O padrão é o mapa de tipos do banco de dados.
writeConcern	MongoDB\Driver\WriteConcern	A referência de escrita padrão a ser usada em operações de collection. O padrão é a preocupação de gravação do banco de dados.

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 Database. As opções podem ser substituídas utilizando o parâmetro $options.

Exemplo

O exemplo a seguir obtém acesso à coleção users no banco de dados test :

<?php
$db = (new MongoDB\Client)->test;
$collection = $db->getCollection('users');

O exemplo a seguir obtém acesso à coleção users no banco de dados test com uma preferência de leitura personalizada :

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

Veja também

Voltar

dropCollection()

getDatabaseName()