wiki.techinc.nl/maintenance/sql.php
Reedy 9bdc558bc4 Add a wfWaitForSlaves() call at the end of sql.php
Useful if you're doing queries over many wikis (wmf usage) that might
induce some repllag

Change-Id: I9818f1763d3330d0b96d9bb9c192a957293b6a5b
2013-02-25 23:57:31 +00:00

135 lines
3.8 KiB
PHP

<?php
/**
* Send SQL queries from the specified file to the database, performing
* variable replacement along the way.
*
* 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
*
* @file
* @ingroup Maintenance
*/
require_once( __DIR__ . '/Maintenance.php' );
/**
* Maintenance script that sends SQL queries from the specified file to the database.
*
* @ingroup Maintenance
*/
class MwSql extends Maintenance {
public function __construct() {
parent::__construct();
$this->mDescription = "Send SQL queries to a MediaWiki database";
$this->addOption( 'cluster', 'Use an external cluster by name', false, true );
}
public function execute() {
// Get a DB handle (with this wiki's DB select) from the appropriate load balancer
if ( $this->hasOption( 'cluster' ) ) {
$lb = wfGetLBFactory()->getExternalLB( $this->getOption( 'cluster' ) );
$dbw = $lb->getConnection( DB_MASTER ); // master for external LB
} else {
$dbw = wfGetDB( DB_MASTER ); // master for primary LB for this wiki
}
if ( $this->hasArg( 0 ) ) {
$file = fopen( $this->getArg( 0 ), 'r' );
if ( !$file ) {
$this->error( "Unable to open input file", true );
}
$error = $dbw->sourceStream( $file, false, array( $this, 'sqlPrintResult' ) );
if ( $error !== true ) {
$this->error( $error, true );
} else {
exit( 0 );
}
}
$useReadline = function_exists( 'readline_add_history' )
&& Maintenance::posix_isatty( 0 /*STDIN*/ );
if ( $useReadline ) {
global $IP;
$historyFile = isset( $_ENV['HOME'] ) ?
"{$_ENV['HOME']}/.mwsql_history" : "$IP/maintenance/.mwsql_history";
readline_read_history( $historyFile );
}
$wholeLine = '';
$newPrompt = '> ';
$prompt = $newPrompt;
while ( ( $line = Maintenance::readconsole( $prompt ) ) !== false ) {
if( !$line ) {
# User simply pressed return key
continue;
}
$done = $dbw->streamStatementEnd( $wholeLine, $line );
$wholeLine .= $line;
if ( !$done ) {
$wholeLine .= ' ';
$prompt = ' -> ';
continue;
}
if ( $useReadline ) {
# Delimiter is eated by streamStatementEnd, we add it
# up in the history (bug 37020)
readline_add_history( $wholeLine . $dbw->getDelimiter() );
readline_write_history( $historyFile );
}
try{
$res = $dbw->query( $wholeLine );
$this->sqlPrintResult( $res, $dbw );
$prompt = $newPrompt;
$wholeLine = '';
} catch (DBQueryError $e) {
$doDie = ! Maintenance::posix_isatty( 0 );
$this->error( $e, $doDie );
}
}
wfWaitForSlaves();
}
/**
* Print the results, callback for $db->sourceStream()
* @param $res ResultWrapper The results object
* @param $db DatabaseBase object
*/
public function sqlPrintResult( $res, $db ) {
if ( !$res ) {
// Do nothing
return;
} elseif ( is_object( $res ) && $res->numRows() ) {
foreach ( $res as $row ) {
$this->output( print_r( $row, true ) );
}
} else {
$affected = $db->affectedRows();
$this->output( "Query OK, $affected row(s) affected\n" );
}
}
/**
* @return int DB_TYPE constant
*/
public function getDbType() {
return Maintenance::DB_ADMIN;
}
}
$maintClass = "MwSql";
require_once( RUN_MAINTENANCE_IF_MAIN );