|
MongoCursor::explainReturn an explanation of the query, often useful for optimization and debugging Description
public array MongoCursor::explain
( void
)
ParametersThis function has no parameters. Return ValuesReturns an explanation of the query. ExamplesExample #1 MongoCursor::explain example
<?php The above example will output something similar to: array(8) { ["cursor"]=> string(15) "BtreeCursor x_1" ["startKey"]=> array(1) { ["x"]=> int(1) } ["endKey"]=> array(1) { ["x"]=> int(1) } ["nscanned"]=> float(4) ["n"]=> int(4) ["scanAndOrder"]=> int(1) ["millis"]=> int(3) ["allPlans"]=> array(2) { [0]=> array(3) { ["cursor"]=> string(15) "BtreeCursor x_1" ["startKey"]=> array(1) { ["x"]=> int(1) } ["endKey"]=> array(1) { ["x"]=> int(1) } } [1]=> array(3) { ["cursor"]=> string(11) "BasicCursor" ["startKey"]=> array(0) { } ["endKey"]=> array(0) { } } } } Errors/ExceptionsThrows MongoConnectionException if it cannot reach the database. See AlsoMongoDB core docs on » explain. |