MongoDB\Driver\CursorInterface
PHP Manual

MongoDB\Driver\CursorInterface::getId

Returns the ID for this cursor

Description

abstract public MongoDB\Driver\CursorIdMongoDB\BSON\Int64 MongoDB\Driver\CursorInterface::getId()

Returns the ID for this cursor, which uniquely identifies the cursor on the server.

Parameters

This function has no parameters.

Return Values

Returns the ID for this cursor.

Errors/Exceptions

  • Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.

Changelog

Version Description
PECL mongodb 1.20.0 Added MongoDB\BSON\Int64 to the tentative return type for this method. MongoDB\Driver\CursorId will be removed from the return type in version 2.0.

See Also

  • MongoDB\Driver\Cursor::getId
  • MongoDB\Driver\CursorId
  • MongoDB\BSON\Int64