MongoDB\Driver\CursorInterface::getId

    (mongodb >=1.6.0)

    MongoDB\Driver\CursorInterface::getId — Returns the ID for this cursor

    Description

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

    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

    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.

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes

    There are no user contributed notes for this page.
    To Top