Documentation

ListCollections
in package
implements Executable

Operation for the listCollections command.

Tags
see
Database::listCollections()
see
http://docs.mongodb.org/manual/reference/command/listCollections/

Interfaces, Classes, Traits and Enums

Executable

Table of Contents

$databaseName  : string
$listCollections  : ListCollections
__construct()  : mixed
Constructs a listCollections command.
execute()  : CollectionInfoIterator
Execute the operation.

Properties

Methods

__construct()

Constructs a listCollections command.

public __construct(string $databaseName[, array<string|int, mixed> $options = [] ]) : mixed

Supported options:

  • authorizedCollections (boolean): Determines which collections are returned based on the user privileges.

    For servers < 4.0, this option is ignored.

  • filter (document): Query by which to filter collections.

  • maxTimeMS (integer): The maximum amount of time to allow the query to run.

  • session (MongoDB\Driver\Session): Client session.

Parameters
$databaseName : string

Database name

$options : array<string|int, mixed> = []

Command options

Tags
throws
InvalidArgumentException

for parameter/option parsing errors

Return values
mixed

Search results