PHP 8.4.1 Released!

MongoDB\Driver\Cursor::getId

(mongodb >=1.0.0)

MongoDB\Driver\Cursor::getIdВозвращает идентификатор текущего курсора

Описание

final public MongoDB\Driver\Cursor::getId(): MongoDB\Driver\CursorId|MongoDB\BSON\Int64

Метод возвращает идентификатор текущего курсора. На сервере каждому курсору присваивается уникальный идентификатор.

Внимание

Возврат объекта MongoDB\Driver\CursorId из метода УСТАРЕЛ с версии модуля 1.20.0. В версии 2.0 параметр asInt64 удалят, а метод будет возвращать объект MongoDB\BSON\Int64.

Список параметров

У этой функции нет параметров.

Возвращаемые значения

Метод возвращает идентификатор текущего курсора. Метод вернёт идентификатор как объект MongoDB\BSON\Int64, если для параметра asInt64 установили значение true, иначе вернёт объект MongoDB\Driver\CursorId и выдаст уведомление об устаревании.

Ошибки

Список изменений

Версия Описание
PECL-модуль mongodb 1.20.0 Возврат объекта MongoDB\Driver\CursorId устарел. Добавили параметр asInt64, чтобы упростить переход на будущие версии. Идентификатор вернётся как объект MongoDB\BSON\Int64, если для параметра asInt64 установили значение true.

Примеры

Пример #1 Пример получения идентификатора курсора методом MongoDB\Driver\Cursor::getId()

<?php

/** Пример добавляет набор документов в коллекцию и указывает
* меньший batchSize, чтобы гарантировать, что первый пакет содержит только
* подмножество результатов, а курсор остаётся открытым на сервере
*/
$manager = new MongoDB\Driver\Manager("mongodb://localhost:27017");
$query = new MongoDB\Driver\Query([], ['batchSize' => 2]);

$bulk = new MongoDB\Driver\BulkWrite();
$bulk->insert(['x' => 1]);
$bulk->insert(['x' => 2]);
$bulk->insert(['x' => 3]);
$manager->executeBulkWrite('db.collection', $bulk);

$cursor = $manager->executeQuery('db.collection', $query);
var_dump($cursor->getId(true));

?>

Вывод приведённого примера будет похож на:

object(MongoDB\BSON\Int64)#5 (1) {
  ["integer"]=>
  string(11) "94810124093"
}

Смотрите также

Добавить

Примечания пользователей

Пользователи ещё не добавляли примечания для страницы
To Top