MongoDB\Client::listDatabaseNames()

Nesta página

Novidade na versão 1.7.

Definição

MongoDB\Client::listDatabaseNames()

Retorna nomes para todos os bancos de dados no servidor.

function listDatabaseNames(array $options = []): Iterator

$options : array

Uma array especificando as opções desejadas.

Nome	Tipo	Descrição
authorizedDatabases	booleano	Um sinalizador que determina quais bancos de dados serão retornados com base nos privilégios do usuário quando o controle de acesso estiver habilitado. Para mais informações, consulte a documentação do comando listDatabases. Para servidores < 4.0.5, esta opção é ignorada. Novidade na versão 1.7.
comentário	misto	Permite ao usuário especificar um comentário arbitrário para ajudar a rastrear a operação por meio do profiler de banco de dados, da saída currentOp e dos registros. Esta opção está disponível desde o MongoDB 4.4 e resultará em uma exceção no momento da execução se for especificada para uma versão mais antiga do servidor. Novidade na versão 1.13.
filtro, filtro	array\|object	Uma expressão de query para filtrar a lista de reconhecimento de data center. Você pode especificar uma query de expressão para campo de reconhecimento de data center (por exemplo, `name`, `sizeOnDisk`, `empty`). Novidade na versão 1.3.
maxTimeMS	inteiro	O limite de tempo cumulativo em milésimos de segundo para operações de processamento no cursor. O MongoDB aborta a operação o mais cedo possível após o ponto de interrupção.
session	MongoDB\Driver\Session	Sessão do cliente a ser associada à operação. Novidade na versão 1.3.

Um iterador, que fornece o nome de cada banco de dados no servidor.

MongoDB\Exception\UnexpectedValueException se a resposta do comando do servidor estiver malformada.

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

MongoDB\Driver\Exception\RuntimeException para outros erros no nível da extensão (por exemplo, erros de conexão).

O exemplo a seguir lista todos os reconhecimento de data center no servidor:

<?php
$client = new MongoDB\Client;
foreach ($client->listDatabaseNames() as $databaseName) {
    var_dump($databaseName);
}

A saída seria então semelhante a:

string(5) "local"
string(4) "test"

Voltar

getWriteConcern()

listDatabases()