MediaWiki  REL1_19
Public Member Functions
BatchedQueryRunner Class Reference

Run a database query in batches and wait for slaves. More...

Inheritance diagram for BatchedQueryRunner:
Inheritance graph
[legend]
Collaboration diagram for BatchedQueryRunner:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 __construct ()
 Default constructor.
 execute ()
 Do the actual work.
 getDbType ()
 Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB.

Detailed Description

Run a database query in batches and wait for slaves.

This is used on large wikis to prevent replication lag from going through the roof when executing large write queries.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html

Definition at line 27 of file runBatchedQuery.php.

Constructor & Destructor Documentation

BatchedQueryRunner::__construct ( )

Default constructor.

Children should call this *first* if implementing their own constructors

Reimplemented from Maintenance.

Definition at line 28 of file runBatchedQuery.php.

Member Function Documentation

BatchedQueryRunner::execute ( )

Do the actual work.

All child classes will need to implement this

Reimplemented from Maintenance.

Definition at line 34 of file runBatchedQuery.php.

References $n, Maintenance\error(), Maintenance\getArg(), Maintenance\hasArg(), Maintenance\output(), wfGetDB(), and wfWaitForSlaves().

Here is the call graph for this function:

BatchedQueryRunner::getDbType ( )

Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB.

Sometimes, a script needs admin rights access for a reason and sometimes they want no access. Subclasses should override and return one of the following values, as needed: Maintenance::DB_NONE - For no DB access at all Maintenance::DB_STD - For normal DB access, default Maintenance::DB_ADMIN - For admin DB access

Returns:
Integer

Reimplemented from Maintenance.

Definition at line 51 of file runBatchedQuery.php.

References Maintenance\DB_ADMIN.

The documentation for this class was generated from the following file: