• API Documentation >
• Result Classes >
• MongoDB\ChangeStream::getCursorId()

MongoDB\ChangeStream::getCursorId()

Definition

MongoDB\ChangeStream::getCursorId

Returns the change stream cursor’s ID.

copy

function getCursorId(): MongoDB\Driver\CursorId

Return Values

A MongoDB\Driver\CursorId object.

Examples

This example reports the cursor ID for a change stream.

copy

<?php

$uri = 'mongodb://rs1.example.com,rs2.example.com/?replicaSet=myReplicaSet';

$collection = (new MongoDB\Client($uri))->test->inventory;

$changeStream = $collection->watch();

var_dump($changeStream->getCursorId());

The output would then resemble:

copy

object(MongoDB\Driver\CursorId)#5 (1) {
  ["id"]=>
  int(8462642181784669708)
}

See Also

• MongoDB\Client::watch()
• MongoDB\Collection::watch()
• MongoDB\Database::watch()
• MongoDB\Driver\CursorId
• MongoDB\Driver\Cursor::getId()

←   MongoDB\ChangeStream::current() MongoDB\ChangeStream::getResumeToken()  →

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.