MongoDB\Driver\Cursor::isDead
(mongodb >=1.0.0)
MongoDB\Driver\Cursor::isDead — Перевіряє, чи курсор вичерпано, чи може містити додаткові результати.
Опис
final public MongoDB\Driver\Cursor::isDead(): bool
Перевіряє, чи немає курсора додаткових результатів. Цей метод аналогічний методу » cursor.isExhausted() в оболонці MongoDB і насамперед корисний при виконанні ітерації » хвостових курсорів
Курсор не має додаткових результатів і вважається "мертвим", якщо виконується одна з наступних умов:
- Поточний пакет повністю повторенийіідентифікатор курсору дорівнює нулю (тобто» getMoreне може бути виконаний).
- Сталася помилка під час ітерації курсору.
- Курсор досяг своєї встановленої межі.
Навмисно не завжди можна визначити, чи курсор має додаткові результати. Випадки, коли курсор може мати більше доступних даних, такі:
- У поточному пакеті є додаткові документи, які буферизуються за клієнта. Ітерація витягне документ із локального буфера.
- У поточному пакеті немає додаткових документів (тобто локального буфера), але ідентифікатор курсору не дорівнює нулю. Ітерація вимагатиме більше документів із сервера за допомогою операції» getMoreяка може повертати або не повертати додаткові результати та/або вказувати, що курсор був закритий на сервері, повертаючи нуль для його ідентифікатора.
Список параметрів
Ця функція не має параметрів.
Значення, що повертаються
Повертає true
, якщо курсор не містить жодних додаткових результатів та false
в іншому випадку.
Помилки
- При помилці парсингу аргумент кидає винятокMongoDB\Driver\Exception\InvalidArgumentException
Приклади
Приклад #1 Приклад використання MongoDB\Driver\Cursor::isDead()****
Loading...
Результат виконання наведеного прикладу:
bool(false)
bool(false)
bool(false)
bool(true)
Дивіться також
- » Хвостові курсориу посібнику MongoDB
- » cursor.isExhausted()у посібнику MongoDB