array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'ru', ), 'this' => array ( 0 => 'mongodb-driver-cursor.getid.php', 1 => 'MongoDB\\Driver\\Cursor::getId', 2 => 'Возвращает идентификатор текущего курсора', ), 'up' => array ( 0 => 'class.mongodb-driver-cursor.php', 1 => 'MongoDB\\Driver\\Cursor', ), 'prev' => array ( 0 => 'mongodb-driver-cursor.current.php', 1 => 'MongoDB\\Driver\\Cursor::current', ), 'next' => array ( 0 => 'mongodb-driver-cursor.getserver.php', 1 => 'MongoDB\\Driver\\Cursor::getServer', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'ru', 'path' => 'reference/mongodb/mongodb/driver/cursor/getid.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

MongoDB\Driver\Cursor::getId

(mongodb >=1.0.0)

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

Описание

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

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

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

Сигнатура функции не содержит параметров.

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

Метод возвращает идентификатор текущего курсора. Метод вернёт идентификатор как объект MongoDB\BSON\Int64.

Ошибки

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

Версия Описание
PECL-модуль mongodb 2.0.0 Тип значения возврата изменили на MongoDB\BSON\Int64. Параметр asInt64 удалили.
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"
}

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