Spec-Zone.ru › Yii 2.0

Класс yii\mongodb\BatchQueryResult

Все классы | Свойства | Методы
Наследование yii\mongodb\BatchQueryResult » yii\base\Object
Реализует Iterator, yii\base\Configurable
Доступно с версии 2.1
Исходный код https://github.com/yiisoft/yii2-mongodb/blob/master/BatchQueryResult.php

BatchQueryResult представляет собой результат пакетного запроса, из которого можно извлекать данные по частям.

Обычно вы не создаёте экземпляр BatchQueryResult напрямую. Вместо этого, вы получаете его, вызвав yii\mongodb\Query::batch() или yii\mongodb\Query::each(). Поскольку BatchQueryResult реализует интерфейс Iterator, вы можете перебирать его, чтобы получить пакет данных в каждом итерационном цикле. Например,

$query = (new Query())->from('user');
foreach ($query->batch() as $i => $users) {
    // $users represents the rows in the $i-th batch
}
foreach ($query->each() as $user) {
}

Публичные свойства

Свойство Тип Описание Определено в
$batchSize integer Количество строк, возвращаемых в каждом пакете. yii\mongodb\BatchQueryResult
$db yii\mongodb\Connection Подключение к MongoDB, используемое при выполнении пакетного запроса. yii\mongodb\BatchQueryResult
$each boolean Возвращать ли одну строку во время каждой итерации. yii\mongodb\BatchQueryResult
$query yii\mongodb\Query Объект запроса, связанный с этим пакетным запросом. yii\mongodb\BatchQueryResult

Публичные методы

Метод Описание Определено в
__call() Вызывает именованный метод, который не является методом класса. yii\base\Object
__construct() Конструктор. yii\base\Object
__get() Возвращает значение свойства объекта. yii\base\Object
__isset() Проверяет, установлено ли свойство, т. е. определено и не равно null. yii\base\Object
__set() Устанавливает значение свойства объекта. yii\base\Object
__unset() Устанавливает свойство объекта в null. yii\base\Object
canGetProperty() Возвращает значение, указывающее, можно ли прочитать свойство. yii\base\Object
canSetProperty() Возвращает значение, указывающее, можно ли установить свойство. yii\base\Object
className() Возвращает полное квалифицированное имя этого класса. yii\base\Object
current() Возвращает текущий набор данных. yii\mongodb\BatchQueryResult
hasMethod() Возвращает значение, указывающее, определен ли метод. yii\base\Object
hasProperty() Возвращает значение, указывающее, определено ли свойство. yii\base\Object
init() Инициализирует объект. yii\base\Object
key() Возвращает индекс текущего набора данных. yii\mongodb\BatchQueryResult
next() Перемещает внутренний указатель к следующему набору данных. yii\mongodb\BatchQueryResult
reset() Сбрасывает пакетный запрос. yii\mongodb\BatchQueryResult
rewind() Сбрасывает итератор в начальное состояние. yii\mongodb\BatchQueryResult
valid() Возвращает, существует ли допустимый набор данных в текущей позиции. yii\mongodb\BatchQueryResult

Защищенные методы

Метод Описание Определено в
fetchData() Извлекает следующий пакет данных. yii\mongodb\BatchQueryResult

Подробности свойств

$batchSize общедоступное свойство

Количество строк, возвращаемых в каждом пакете.

public integer $batchSize = 100

$db общедоступное свойство

Подключение MongoDB, используемое при выполнении пакетного запроса. Если null, используется компонент приложения "mongodb".

public yii\mongodb\Connection $db = null

$each общедоступное свойство

Возвращать ли одну строку во время каждой итерации. Если false, весь пакет строк будет возвращен в каждой итерации.

public boolean $each = false

$query общедоступное свойство

Объект запроса, связанный с этим пакетным запросом. Не изменяйте это свойство напрямую, если только не после явного вызова reset().

public yii\mongodb\Query $query = null

Подробности методов

current() public method

Возвращает текущий набор данных.

Этот метод требуется интерфейсом Iterator.

public mixed current ( )
return mixed

Текущий набор данных.

fetchData() protected method

Извлекает следующий пакет данных.

protected array fetchData ( )
return array

Извлеченные данные

key() public method

Возвращает индекс текущего набора данных.

Этот метод требуется интерфейсом Iterator.

public integer key ( )
return integer

Индекс текущей строки.

next() public method

Перемещает внутренний указатель к следующему набору данных.

Этот метод требуется интерфейсом Iterator.

public void next ( )

reset() public method

Сбрасывает пакет запроса.

Этот метод очистит существующий пакет запроса, чтобы можно было выполнить новый пакет запроса.

public void reset ( )

rewind() public method

Сбрасывает итератор в начальное состояние.

Этот метод требуется интерфейсом Iterator.

public void rewind ( )

valid() public method

Возвращает, есть ли допустимый набор данных в текущей позиции.

Этот метод требуется интерфейсом Iterator.

public boolean valid ( )
return boolean

Есть ли допустимый набор данных в текущей позиции.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-mongodb-batchqueryresult.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API