MediaWiki  REL1_20
BatchedQueryRunner Class Reference

Maintenance script to run a database query in batches and wait for slaves. More...

Inheritance diagram for BatchedQueryRunner:
Collaboration diagram for BatchedQueryRunner:

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

Maintenance script to run a database query in batches and wait for slaves.

Definition at line 33 of file runBatchedQuery.php.


Constructor & Destructor Documentation

Default constructor.

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

Reimplemented from Maintenance.

Definition at line 34 of file runBatchedQuery.php.


Member Function Documentation

Do the actual work.

All child classes will need to implement this

Reimplemented from Maintenance.

Definition at line 40 of file runBatchedQuery.php.

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

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 57 of file runBatchedQuery.php.

References Maintenance\DB_ADMIN.


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