MapReduceResult.md

---

MapReduceResult

Result class for mapReduce command results.

This class allows for iteration of mapReduce results irrespective of the output method (e.g. inline, collection) via the IteratorAggregate interface. It also provides access to command statistics.

• Full name: \MongoDB\MapReduceResult
• This class implements: \IteratorAggregate

See Also:

• \MongoDB\Collection::mapReduce() -
• https://docs.mongodb.com/manual/reference/command/mapReduce/ -

Properties

getIterator

private callable $getIterator

---

executionTimeMS

private int $executionTimeMS

---

counts

private array $counts

---

timing

private array $timing

---

Methods

getCounts

Returns various count statistics from the mapReduce command.

public getCounts(): array

---

getExecutionTimeMS

Return the command execution time in milliseconds.

public getExecutionTimeMS(): int

---

getIterator

Return the mapReduce results as a Traversable.

public getIterator(): \Traversable

See Also:

• http://php.net/iteratoraggregate.getiterator -

---

getTiming

Returns various timing statistics from the mapReduce command.

public getTiming(): array

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

---

---