php8.5
Home/ Manual/ driver / cursorinterface/ MongoDB\Driver\CursorInterface::isDead

MongoDB\Driver\CursorInterface::isDead

PHP function Edit on GitHub ✎

(mongodb >=1.6.0)

Checks if the cursor may have additional results

Description

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 Parameters

Return Values

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

Errors/Exceptions

See Also

  • MongoDB\Driver\Cursor::isDead

Source: reference/mongodb/mongodb/driver/cursorinterface/isdead.xml · from the official PHP manual (php/doc-en)