MongoDB::getCollectionInfo
(PECL mongo >=1.6.0)
MongoDB::getCollectionInfo — Returns information about collections in this database
Description
$options = array()
] ) : arrayGets a list of all collections in the database and returns them as an array of documents, which contain their names and options.
Note: This method will use the » listCollections database command when communicating with MongoDB 2.8+. For previous database versions, the method will query the special
system.namespacescollection.
Parameters
-
options -
An array of options for listing the collections. Currently available options include:
"filter"Optional query criteria. If provided, this criteria will be used to filter the collections included in the result.
Relevant fields that may be queried include
"name"(collection name as a string, without the database name prefix) and"options" (object containing options used to create the collection)..Note: MongoDB 2.6 and earlier versions require the
"name"criteria, if specified, to be a string value (i.e. equality match). This is because the driver must prefix the value with the database name in order to query thesystem.namespacescollection. Later versions of MongoDB do not have this limitation, as the driver will use the listCollections command."includeSystemCollections"Boolean, defaults to
FALSE. Determines whether system collections should be included in the result.
The following option may be used with MongoDB 2.8+:
"maxTimeMS"Specifies a cumulative time limit in milliseconds for processing the operation on the server (does not include idle time). If the operation is not completed by the server within the timeout period, a MongoExecutionTimeoutException will be thrown.
Return Values
This function returns an array where each element is an array describing a
collection. Elements will contain a name key denoting the
name of the collection, and optionally contain an options
key denoting an array of objects used to create the collection. For example,
capped collections will include capped and
size options.
Errors/Exceptions
For MongoDB 2.6 and earlier, MongoException will be
thrown if a non-string value was specified for the
"filter" option's "name" criteria.
Examples
Example #1 MongoDB::getCollectionInfo() example
<?php
$m = new MongoClient();
$db = $m->selectDB("demo");
var_dump($db->getCollectionInfo());
?>
The above example will output something similar to:
array(2) {
[0]=>
array(2) {
["name"]=>
string(4) "logs"
["options"]=>
array(2) {
["capped"]=>
bool(true)
["size"]=>
int(10240)
}
}
[1]=>
array(2) {
["name"]=>
string(5) "users"
["options"]=>
array(1) {
["flags"]=>
int(1)
}
}
}
See Also
- MongoDB::getCollectionNames() - Gets an array of names for all collections in this database
- MongoDB::listCollections() - Gets an array of MongoCollection objects for all collections in this database
add a note
