PHP Class yii\db\BatchQueryResult
You usually do not instantiate BatchQueryResult directly. Instead, you obtain it by
calling [[Query::batch()]] or [[Query::each()]]. Because BatchQueryResult implements the [[\Iterator]] interface,
you can iterate it to obtain a batch of data in each iteration. For example,
php
$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) {
}
Afficher le fichier
Open project: yiisoft/yii2
Class Usage Examples
Méthodes publiques
Свойство |
Type |
Description |
|
$batchSize |
|
the number of rows to be returned in each batch. |
|
$db |
|
the DB connection to be used when performing batch query.
If null, the "db" application component will be used. |
|
$each |
|
whether to return a single row during each iteration.
If false, a whole batch of rows will be returned in each iteration. |
|
$query |
|
the query object associated with this batch query.
Do not modify this property directly unless after BatchQueryResult::reset is called explicitly. |
|
Méthodes publiques
Méthode |
Description |
|
__destruct ( ) |
Destructor. |
|
current ( ) : mixed |
Returns the current dataset. |
|
key ( ) : integer |
Returns the index of the current dataset. |
|
next ( ) |
Moves the internal pointer to the next dataset. |
|
reset ( ) |
Resets the batch query. |
|
rewind ( ) |
Resets the iterator to the initial state. |
|
valid ( ) : boolean |
Returns whether there is a valid dataset at the current position. |
|
Méthodes protégées
Méthode |
Description |
|
fetchData ( ) : array |
Fetches the next batch of data. |
|
Method Details
__destruct()
public méthode
This method is required by the interface [[\Iterator]].
fetchData()
protected méthode
Fetches the next batch of data.
This method is required by the interface [[\Iterator]].
This method is required by the interface [[\Iterator]].
This method will clean up the existing batch query so that a new batch query can be performed.
This method is required by the interface [[\Iterator]].
This method is required by the interface [[\Iterator]].
public valid ( ) : boolean |
Résultat |
boolean |
whether there is a valid dataset at the current position. |
Property Details
$batchSize public_oe property
the number of rows to be returned in each batch.
the DB connection to be used when performing batch query.
If null, the "db" application component will be used.
whether to return a single row during each iteration.
If false, a whole batch of rows will be returned in each iteration.
$query public_oe property
the query object associated with this batch query.
Do not modify this property directly unless after
BatchQueryResult::reset is called explicitly.