mongodb\Query batch()

batch() public method (available since version 2.1)

Starts a batch query.

A batch query supports fetching data in batches, which can keep the memory usage under a limit. This method will return a yii\mongodb\BatchQueryResult object which implements the Iterator interface and can be traversed to retrieve the data in batches.

For example,

$query = (new Query)->from('user');
foreach ($query->batch() as $rows) {
    // $rows is an array of 10 or fewer rows from user collection
}

public yii\mongodb\BatchQueryResult batch ( $batchSize = 100, $db = null )
$batchSize	integer	The number of records to be fetched in each batch.
$db	yii\mongodb\Connection	The MongoDB connection. If not set, the "mongodb" application component will be used.
return	yii\mongodb\BatchQueryResult	The batch query result. It implements the `Iterator` interface and can be traversed to retrieve the data in batches.

Links:

http://www.yiiframework.com/doc-2.0/yii-mongodb-query.html#batch()-detail

doc_Yii

2016-10-30 17:08:55

Comments