MongoDB\Client::listDatabases()

Definição

MongoDB\Client::listDatabases()

Retorna informações para todos os reconhecimento de data center no servidor.

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

Parâmetros

$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 saber mais, consulte a referência do comando listDatabases no manual do MongoDB Server. Novidade na versão 1.7.
comment	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.

Return Values

Uma instância do Iterador, que fornece um objeto MongoDB\Model\DatabaseInfo para cada banco de dados no servidor.

Erros/exceções

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).

Exemplo

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

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

A saída seria então semelhante a:

object(MongoDB\Model\DatabaseInfo)#4 (3) {
  ["name"]=>
  string(5) "local"
  ["sizeOnDisk"]=>
  float(65536)
  ["empty"]=>
  bool(false)
}
object(MongoDB\Model\DatabaseInfo)#7 (3) {
  ["name"]=>
  string(4) "test"
  ["sizeOnDisk"]=>
  float(32768)
  ["empty"]=>
  bool(false)
}

Veja também

• MongoDB\Client::listDatabaseNames()

• Referência do comando listDatabases no manual MongoDB

• Especificação de bancos de dados de enumeração