MediaWiki master
|
Allows iterating a large number of rows in batches transparently. More...
Inherits RecursiveIterator.
Public Member Functions | |
__construct (IReadableDatabase $db, $table, $primaryKey, $batchSize) | |
addConditions (array $conditions) | |
addJoinConditions (array $conditions) | |
addOptions (array $options) | |
current () | |
extractPrimaryKeys ( $row) | |
Extracts the primary key(s) from a database row. | |
getChildren () | |
hasChildren () | |
key () | |
next () | |
Fetch the next set of rows from the database. | |
rewind () | |
Reset the iterator to the beginning of the table. | |
setCaller ( $caller) | |
Use ->setCaller( METHOD ) to indicate which code is using this class. | |
setFetchColumns (array $columns) | |
valid () | |
Protected Member Functions | |
buildConditions () | |
Uses the primary key list and the maximal result row from the previous iteration to build an SQL condition sufficient for selecting the next page of results. | |
Protected Attributes | |
int | $batchSize |
The number of rows to fetch per iteration. | |
string null | $caller |
For debugging which method is using this class. | |
array | $conditions = [] |
Array of strings containing SQL conditions to add to the query. | |
IReadableDatabase | $db |
array | $fetchColumns |
List of column names to select from the table suitable for use with IDatabase::select() | |
array | $joinConditions = [] |
array | $options = [] |
Additional query options. | |
string | $orderBy |
SQL Order by condition generated from $this->primaryKey. | |
array | $primaryKey |
The name of the primary key(s) | |
string array | $table |
The name or names of the table to read from. | |
Allows iterating a large number of rows in batches transparently.
By default when iterated over returns the full query result as an array of rows. Can be wrapped in RecursiveIteratorIterator to collapse those arrays into a single stream of rows queried in batches.
Definition at line 33 of file BatchRowIterator.php.
BatchRowIterator::__construct | ( | IReadableDatabase | $db, |
$table, | |||
$primaryKey, | |||
$batchSize ) |
IReadableDatabase | $db | |
string | array | $table | The name or names of the table to read from |
string | array | $primaryKey | The name or names of the primary key columns |
int | $batchSize | The number of rows to fetch per iteration |
Definition at line 104 of file BatchRowIterator.php.
References $batchSize, $db, $primaryKey, and $table.
BatchRowIterator::addConditions | ( | array | $conditions | ) |
array | $conditions | Query conditions suitable for use with IDatabase::select |
Definition at line 120 of file BatchRowIterator.php.
References $conditions.
Referenced by CategoryChangesAsRdf\getCategoryLinksIterator().
BatchRowIterator::addJoinConditions | ( | array | $conditions | ) |
array | $conditions | Query join conditions suitable for use with IDatabase::select |
Definition at line 136 of file BatchRowIterator.php.
References $conditions.
BatchRowIterator::addOptions | ( | array | $options | ) |
array | $options | Query options suitable for use with IDatabase::select |
Definition at line 128 of file BatchRowIterator.php.
References $options.
|
protected |
Uses the primary key list and the maximal result row from the previous iteration to build an SQL condition sufficient for selecting the next page of results.
Definition at line 264 of file BatchRowIterator.php.
BatchRowIterator::current | ( | ) |
Definition at line 188 of file BatchRowIterator.php.
BatchRowIterator::extractPrimaryKeys | ( | $row | ) |
Extracts the primary key(s) from a database row.
stdClass | $row | An individual database row from this iterator |
Definition at line 176 of file BatchRowIterator.php.
BatchRowIterator::getChildren | ( | ) |
Definition at line 225 of file BatchRowIterator.php.
BatchRowIterator::hasChildren | ( | ) |
Definition at line 218 of file BatchRowIterator.php.
BatchRowIterator::key | ( | ) |
Definition at line 195 of file BatchRowIterator.php.
BatchRowIterator::next | ( | ) |
Fetch the next set of rows from the database.
Definition at line 232 of file BatchRowIterator.php.
BatchRowIterator::rewind | ( | ) |
Reset the iterator to the beginning of the table.
Definition at line 202 of file BatchRowIterator.php.
BatchRowIterator::setCaller | ( | $caller | ) |
Use ->setCaller( METHOD ) to indicate which code is using this class.
Only used in debugging output.
string | $caller |
Definition at line 164 of file BatchRowIterator.php.
References $caller.
Referenced by CategoryChangesAsRdf\getCategoryLinksIterator().
BatchRowIterator::setFetchColumns | ( | array | $columns | ) |
array | $columns | List of column names to select from the table suitable for use with IDatabase::select() |
Definition at line 144 of file BatchRowIterator.php.
Referenced by CategoryChangesAsRdf\getCategoryLinksIterator().
BatchRowIterator::valid | ( | ) |
Definition at line 211 of file BatchRowIterator.php.
|
protected |
The number of rows to fetch per iteration.
Definition at line 53 of file BatchRowIterator.php.
Referenced by __construct().
|
protected |
For debugging which method is using this class.
Definition at line 94 of file BatchRowIterator.php.
Referenced by setCaller().
|
protected |
Array of strings containing SQL conditions to add to the query.
Definition at line 58 of file BatchRowIterator.php.
Referenced by addConditions(), and addJoinConditions().
|
protected |
Definition at line 38 of file BatchRowIterator.php.
Referenced by __construct().
|
protected |
List of column names to select from the table suitable for use with IDatabase::select()
Definition at line 69 of file BatchRowIterator.php.
|
protected |
Definition at line 63 of file BatchRowIterator.php.
|
protected |
Additional query options.
Definition at line 89 of file BatchRowIterator.php.
Referenced by addOptions().
|
protected |
SQL Order by condition generated from $this->primaryKey.
Definition at line 74 of file BatchRowIterator.php.
|
protected |
The name of the primary key(s)
Definition at line 48 of file BatchRowIterator.php.
Referenced by __construct().
|
protected |
The name or names of the table to read from.
Definition at line 43 of file BatchRowIterator.php.
Referenced by __construct().