MongoDB\Driver\CursorInterface::getId

Returns the ID for this cursor

説明

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.

パラメータ

この関数にはパラメータはありません。

戻り値

Returns the ID for this cursor.

エラー / 例外

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

変更履歴

バージョン 説明
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.

参考

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