MongoDB\MapReduceResult Class Reference

Inheritance diagram for MongoDB\MapReduceResult:

Public Member Functions
	__construct (callable $getIterator, stdClass $result)
	getCounts ()
	Returns various count statistics from the mapReduce command.
	getExecutionTimeMS ()
	Return the command execution time in milliseconds.
	getIterator ()
	Return the mapReduce results as a Traversable.
	getTiming ()
	Returns various timing statistics from the mapReduce command.

Member Function Documentation

getCounts()

MongoDB\MapReduceResult::getCounts

(

)

Returns various count statistics from the mapReduce command.

Return values

array

getExecutionTimeMS()

MongoDB\MapReduceResult::getExecutionTimeMS

(

)

Return the command execution time in milliseconds.

Return values

integer

getIterator()

MongoDB\MapReduceResult::getIterator

(

)

Return the mapReduce results as a Traversable.

See also

https://php.net/iteratoraggregate.getiterator

Return values

Traversable

getTiming()

MongoDB\MapReduceResult::getTiming

(

)

Returns various timing statistics from the mapReduce command.

Note: timing statistics are only available if the mapReduce command's "verbose" option was true; otherwise, an empty array will be returned.

Return values

array

---

The documentation for this class was generated from the following file:

• cache/stores/mongodb/MongoDB/MapReduceResult.php