MongoCollection::getDBRefMongoCollection::getIndexInfo
(PECL mongo >=0.9.0)
MongoCollection::getIndexInfo — Returns information about indexes on this collection
Description
public array MongoCollection::getIndexInfo
( void
)
Parameters
This function has no parameters.
Return Values
This function returns an array in which each elements describes an array. The elements contain the values name for the name of the index, ns for the namespace (the name of the collection), key containing a list of all the keys and their sort order that make up the index and _id containing a MongoID object with the ID of this index.
Examples
Example #1 MongoCollection::find() example
This example demonstrates how to search for a range.
<?php
$m = new Mongo;
$c = $m->selectCollection('project', 'outfits');
var_dump($c->getIndexInfo());
?>
The above example will output:
array(8) {
[0] =>
array(3) {
'name' =>
string(4) '_id_'
'ns' =>
string(12) 'project.outfits'
'key' =>
array(1) {
'_id' =>
int(1)
}
}
...
[7] =>
array(4) {
'_id' =>
class MongoId#12 (1) {
public $$id => string(24) '4d6f7abd44670a1513190000'
}
'ns' =>
string(12) 'project.outfits'
'key' =>
array(2) {
'created' =>
int(-1)
'userid' =>
int(1)
}
'name' =>
string(19) 'created_-1_userid_1'
}
}
See MongoCursor for more information how to work with cursors.
add a note
User Contributed Notes
MongoCollection::getIndexInfo
There are no user contributed notes for this page.