Until now, we relied on setting MW_NO_SETUP which was a) hacky, b) irreversable, and c) likely to be forgotten if you didn't use one of the wrappers like runChild(). Instead, move the freaky magic to doMaintenance and have *it* check if it's in a specific call stack that indicates this is being run from the file scope and should be executed. Rename DO_MAINTENANCE to RUN_MAINTENANCE_IF_MAIN so it's nice and clear what magic happens behind the require_once().
60 lines
2 KiB
PHP
60 lines
2 KiB
PHP
<?php
|
|
/**
|
|
* 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
|
|
*
|
|
* @ingroup Maintenance
|
|
*/
|
|
|
|
require_once( dirname( __FILE__ ) . '/Maintenance.php' );
|
|
|
|
class BatchedQueryRunner extends Maintenance {
|
|
public function __construct() {
|
|
parent::__construct();
|
|
$this->mDescription = "Run a query repeatedly until it affects 0 rows, and wait for slaves in between.\n" .
|
|
"NOTE: You need to set a LIMIT clause yourself.";
|
|
$this->addOption( 'wait', "Wait for replication lag to go down to this value. Default: 5", false, true );
|
|
}
|
|
|
|
public function execute() {
|
|
if ( !$this->hasArg() )
|
|
$this->error( "No query specified. Specify the query as a command line parameter.", true );
|
|
|
|
$query = $this->getArg();
|
|
$wait = $this->getOption( 'wait', 5 );
|
|
$n = 1;
|
|
$dbw = wfGetDb( DB_MASTER );
|
|
do {
|
|
$this->output( "Batch $n: " );
|
|
$n++;
|
|
$dbw->query( $query, __METHOD__ );
|
|
$affected = $dbw->affectedRows();
|
|
$this->output( "$affected rows\n" );
|
|
wfWaitForSlaves( $wait );
|
|
} while ( $affected > 0 );
|
|
}
|
|
|
|
public function getDbType() {
|
|
return Maintenance::DB_ADMIN;
|
|
}
|
|
}
|
|
|
|
|
|
$maintClass = "BatchedQueryRunner";
|
|
require_once( RUN_MAINTENANCE_IF_MAIN );
|