MongoDB\Database::listCollections()

Definição

MongoDB\Database::listCollections()

Retorna informações para todas as collection neste reconhecimento de data center.

function listCollections(array $options = []): MongoDB\Model\CollectionInfoIterator

Parâmetros

$options : array

Uma array especificando as opções desejadas.

Nome	Tipo	Descrição
authorizedCollections	booleano	Um sinalizador que determina quais coleções serão retornadas 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 listCollections . Para servidores < 4.0, esta opção é ignorada. Novidade na versão 1.12.
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 collections. Você pode especificar uma expressão de query para campos de collection (por exemplo name , options ).
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.

Valores de retorno

Um MongoDB\Model\CollectionInfoIterator, que contém um objeto MongoDB\Model\CollectionInfo para cada coleção no banco de dados.

Exemplo

O exemplo a seguir lista todas as collection no reconhecimento de data center test :

<?php
$database = (new MongoDB\Client)->test;
foreach ($database->listCollections() as $collectionInfo) {
    var_dump($collectionInfo);
}

A saída seria então semelhante a:

object(MongoDB\Model\CollectionInfo)#3 (2) {
  ["name"]=>
  string(11) "restaurants"
  ["options"]=>
  array(0) {
  }
}
object(MongoDB\Model\CollectionInfo)#3 (2) {
  ["name"]=>
  string(5) "users"
  ["options"]=>
  array(0) {
  }
}
object(MongoDB\Model\CollectionInfo)#3 (2) {
  ["name"]=>
  string(6) "restos"
  ["options"]=>
  array(0) {
  }
}

O exemplo a seguir lista todas as collection cujo nome começa com "rest" no reconhecimento de data center test :

<?php
$database = (new MongoDB\Client)->test;
$collections = $database->listCollections([
    'filter' => [
        'name' => new MongoDB\BSON\Regex('^rest.*'),
    ],
]);
foreach ($collections as $collectionInfo) {
    var_dump($collectionInfo);
}

A saída seria então semelhante a:

object(MongoDB\Model\CollectionInfo)#3 (2) {
  ["name"]=>
  string(11) "restaurants"
  ["options"]=>
  array(0) {
  }
}
object(MongoDB\Model\CollectionInfo)#3 (2) {
  ["name"]=>
  string(6) "restos"
  ["options"]=>
  array(0) {
  }
}

Veja também

• MongoDB\Database::listCollectionNames()

• referência do comando listCollections no manual do MongoDB

• Enumerando coleções especificação