MongoDB\Client::getDatabase()

Definição

MongoDB\Client::getDatabase()

Obtém acesso a um banco de dados no servidor. Este método é um alias para MongoDB\Client::selectDatabase() e o substituirá em uma versão futura.

function getDatabase(
    string $databaseName,
    array $options = []
): MongoDB\Database

Parâmetros

$databaseName : string

O nome do banco de dados a ser acessado.

$options : array

Uma array especificando as opções desejadas.

Nome	Tipo	Descrição
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 cliente.
readPreference	MongoDB\Driver\ReadPreference	A preferência de leitura padrão a ser usada para operações de reconhecimento de data center. O padrão é a preferência de leitura do cliente.
typeMap	array	O mapa de tipos padrão a ser usado para operações do banco de dados. O padrão é o mapa de tipos do cliente.
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 cliente.

Return Values

Um objeto MongoDB\Database .

Erros/exceções

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

Comportamento

O banco de dados selecionado 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 obtém acesso ao banco de dados test :

<?php
$client = new MongoDB\Client;
$db = $client->getDatabase('test');

Os exemplos a seguir obtém acesso ao banco de dados do test com uma preferência de leitura personalizada :

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

Veja também

• MongoDB\Client::__get()

• MongoDB\Database::__construct()