MongoDB\Driver\CursorInterface::isDead

    (mongodb >=1.6.0)

    MongoDB\Driver\CursorInterface::isDead — Checks if the cursor may have additional results

    Description

    abstract public MongoDB\Driver\CursorInterface::isDead(): bool

    Checks whether the cursor may have additional results available to read. A cursor is initially "alive" but may become "dead" for any of the following reasons:

    • Advancing a non-tailable cursor did not return a document
    • The cursor encountered an error
    • The cursor read its last batch to completion
    • The cursor reached its configured limit
    This is primarily useful with tailable cursors.

    Parameters

    This function has no parameters.

    Return Values

    Returns true if additional results are not available, and false otherwise.

    Errors/Exceptions

    See Also

    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