(mongodb >=1.0.0)
MongoDB\Driver\Cursor::getId — Returns the ID for this cursor
Returns the ID for this cursor, which uniquely identifies the cursor on the server.
This function has no parameters.
Returns the ID for this cursor. The ID will be returned as a MongoDB\BSON\Int64 object.
| Version | Description |
|---|---|
| PECL mongodb 2.0.0 |
The return type was changed to MongoDB\BSON\Int64.
The asInt64 parameter was removed.
|
| PECL mongodb 1.20.0 |
Deprecated returning a MongoDB\Driver\CursorId.
Added the asInt64 argument to ease migration for
future versions. If asInt64 is true, the ID
will be returned as a MongoDB\BSON\Int64.
|
Example #1 MongoDB\Driver\Cursor::getId() example
<?php
/* In this example, we insert several documents into the collection and specify
* a smaller batchSize to ensure that the first batch contains only a subset of
* our results and the cursor remains open on the server. */
$manager = new MongoDB\Driver\Manager("mongodb://localhost:27017");
$query = new MongoDB\Driver\Query([], ['batchSize' => 2]);
$bulk = new MongoDB\Driver\BulkWrite;
$bulk->insert(['x' => 1]);
$bulk->insert(['x' => 2]);
$bulk->insert(['x' => 3]);
$manager->executeBulkWrite('db.collection', $bulk);
$cursor = $manager->executeQuery('db.collection', $query);
var_dump($cursor->getId(true));
?>The above example will output something similar to:
object(MongoDB\BSON\Int64)#5 (1) {
["integer"]=>
string(11) "94810124093"
}