MongoDB\Driver\CursorInterface::isDead
(mongodb >=1.6.0)
MongoDB\Driver\CursorInterface::isDead — Checks if the cursor may have additional results
Description
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
Parameters
This function has no parameters.
Return Values
Returns true if additional results are not available, and false
otherwise.
Errors/Exceptions
- Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.
See Also
- MongoDB\Driver\Cursor::isDead() - Checks if the cursor is exhausted or may have additional results
add a note
User Contributed Notes
There are no user contributed notes for this page.
