MongoDB\Database::listCollectionNames()

Definição

MongoDB\Database::listCollectionNames()

Retorna nomes para todas as collection neste reconhecimento de data center.

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

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.

Valores de retorno

Um iterador, que fornece o nome de 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->listCollectionNames() as $collectionName) {
    var_dump($collectionName);
}

A saída seria então semelhante a:

string(11) "restaurants"
string(5) "users"
string(6) "restos"

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->listCollectionNames([
    'filter' => [
        'name' => new MongoDB\BSON\Regex('^rest.*'),
    ],
]);
foreach ($collections as $collectionName) {
    var_dump($collectionName);
}

A saída seria então semelhante a:

string(11) "restaurants"
string(6) "restos"

Veja também

• MongoDB\Database::listCollections()

• referência do comando listCollections no manual do MongoDB

• Enumerando coleções especificação