(PECL mongo >=0.9.0)
Examples:
MongoCursor basic usage

A cursor is used to iterate through the results of a database query. For example, to query the database and see all results, you could do:

<?php

$cursor = $collection->find();
var_dump(iterator_to_array($cursor));

?>

Iterating over MongoCursor

You don't generally create cursors using the MongoCursor constructor, you get a new cursor by calling MongoCollection::find() (as shown above).

Suppose that, in the example above, $collection was a 50GB collection. We certainly wouldn't want to load that into memory all at once, which is what a cursor is for: allowing the client to access the collection in dribs and drabs.

If we have a large result set, we can iterate through it, loading a few megabytes of results into memory at a time. For example, we could do:

<?php

$cursor = $collection->find();

foreach ($cursor as $doc) {
    // do something to each document
}

?>

Adding options to MongoCursor

A MongoCursor has two "life stages": pre- and post- query. When a cursor is created, it has not yet contacted the database, so it is in its pre-query state. In this state, the client can further specify what they want the query to do, including adding limits, skips, sorts, and more advanced options.

When the client attempts to get a result (by calling MongoCursor::next(), directly or indirectly), the cursor moves into the post-query stage. At this point, the query has been executed by the database and cannot be modified anymore.

<?php

$cursor = $collection->find()->limit(10);

// database has not yet been queried, so more search options can be added
$cursor = $cursor->sort(array("a" => 1));

var_dump($cursor->getNext());
// now database has been queried and more options cannot be added

// so this will throw an exception:
$cursor->skip(4);
?>

MongoCursor::addOption

(PECL mongo >=1.0.4) Adds a top-level key/value pair to a query

2016-02-24 16:20:41
MongoCursor::doQuery

(PECL mongo >=0.9.0 <1.6.0) Execute the query.

2016-02-24 16:20:42
MongoCursor::explain

(PECL mongo >=0.9.2) Return an explanation of the query, often useful for optimization and debugging

2016-02-24 16:20:42
MongoCursor::partial

(PECL mongo >=1.2.0) If this query should fetch partial results from mongos if

2016-02-24 16:20:43
MongoCursor::current

(PECL mongo >=0.9.0) Returns the current element

2016-02-24 16:20:41
MongoCursor::count

(PECL mongo >=0.9.2) Counts the number of results for this query

2016-02-24 16:20:41
MongoCursor::__construct

(PECL mongo >=0.9.0) Create a new cursor public

2016-02-24 16:20:41
MongoCursor::tailable

(PECL mongo >=0.9.4) Sets whether this cursor will be left open after fetching the last results

2016-02-24 16:20:45
MongoCursor::setReadPreference

(PECL mongo >=1.3.3) Set the read preference for this query

2016-02-24 16:20:44
MongoCursor::dead

(PECL mongo >=0.9.6) Checks if there are results that have not yet been sent from the database

2016-02-24 16:20:41