* 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 Database Maintenance
+ * @ingroup Maintenance
*/
-require_once( dirname(__FILE__) . '/' . 'commandLine.inc' );
+require_once __DIR__ . '/Maintenance.php';
-if ( isset( $options['help'] ) ) {
- echo "Send SQL queries to a MediaWiki database.\nUsage: php sql.php [<file>]\n";
- exit( 1 );
-}
+use Wikimedia\Rdbms\ResultWrapper;
+use Wikimedia\Rdbms\IDatabase;
+use Wikimedia\Rdbms\DBQueryError;
-if ( isset( $args[0] ) ) {
- $fileName = $args[0];
- $file = fopen( $fileName, 'r' );
- $promptCallback = false;
-} else {
- $file = STDIN;
- $promptObject = new SqlPromptPrinter( "> " );
- $promptCallback = $promptObject->cb();
-}
+/**
+ * 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->addDescription( 'Send SQL queries to a MediaWiki database. ' .
+ 'Takes a file name containing SQL as argument or runs interactively.' );
+ $this->addOption( 'query',
+ 'Run a single query instead of running interactively', false, true );
+ $this->addOption( 'cluster', 'Use an external cluster by name', false, true );
+ $this->addOption( 'wikidb',
+ 'The database wiki ID to use if not the current one', false, true );
+ $this->addOption( 'replicadb',
+ 'Replica DB server to use instead of the master DB (can be "any")', false, true );
+ }
-if ( !$file ) {
- echo "Unable to open input file\n";
- exit( 1 );
-}
+ public function execute() {
+ global $IP;
-$dbw =& wfGetDB( DB_MASTER );
-$error = $dbw->sourceStream( $file, $promptCallback, 'sqlPrintResult' );
-if ( $error !== true ) {
- echo $error;
- exit( 1 );
-} else {
- exit( 0 );
-}
+ // We wan't to allow "" for the wikidb, meaning don't call select_db()
+ $wiki = $this->hasOption( 'wikidb' ) ? $this->getOption( 'wikidb' ) : false;
+ // Get the appropriate load balancer (for this wiki)
+ if ( $this->hasOption( 'cluster' ) ) {
+ $lb = wfGetLBFactory()->getExternalLB( $this->getOption( 'cluster' ) );
+ } else {
+ $lb = wfGetLB( $wiki );
+ }
+ // Figure out which server to use
+ $replicaDB = $this->getOption( 'replicadb', $this->getOption( 'slave', '' ) );
+ if ( $replicaDB === 'any' ) {
+ $index = DB_REPLICA;
+ } elseif ( $replicaDB != '' ) {
+ $index = null;
+ $serverCount = $lb->getServerCount();
+ for ( $i = 0; $i < $serverCount; ++$i ) {
+ if ( $lb->getServerName( $i ) === $replicaDB ) {
+ $index = $i;
+ break;
+ }
+ }
+ if ( $index === null ) {
+ $this->error( "No replica DB server configured with the name '$replicaDB'.", 1 );
+ }
+ } else {
+ $index = DB_MASTER;
+ }
-//-----------------------------------------------------------------------------
-class SqlPromptPrinter {
- function __construct( $prompt ) {
- $this->prompt = $prompt;
- }
+ /** @var IDatabase $db DB handle for the appropriate cluster/wiki */
+ $db = $lb->getConnection( $index, [], $wiki );
+ if ( $replicaDB != '' && $db->getLBInfo( 'master' ) !== null ) {
+ $this->error( "The server selected ({$db->getServer()}) is not a replica DB.", 1 );
+ }
+
+ if ( $index === DB_MASTER ) {
+ $updater = DatabaseUpdater::newForDB( $db, true, $this );
+ $db->setSchemaVars( $updater->getSchemaVars() );
+ }
+
+ if ( $this->hasArg( 0 ) ) {
+ $file = fopen( $this->getArg( 0 ), 'r' );
+ if ( !$file ) {
+ $this->error( "Unable to open input file", true );
+ }
+
+ $error = $db->sourceStream( $file, null, [ $this, 'sqlPrintResult' ] );
+ if ( $error !== true ) {
+ $this->error( $error, true );
+ } else {
+ exit( 0 );
+ }
+ }
+
+ if ( $this->hasOption( 'query' ) ) {
+ $query = $this->getOption( 'query' );
+ $this->sqlDoQuery( $db, $query, /* dieOnError */ true );
+ wfWaitForSlaves();
+ return;
+ }
+
+ if (
+ function_exists( 'readline_add_history' ) &&
+ Maintenance::posix_isatty( 0 /*STDIN*/ )
+ ) {
+ $historyFile = isset( $_ENV['HOME'] ) ?
+ "{$_ENV['HOME']}/.mwsql_history" : "$IP/maintenance/.mwsql_history";
+ readline_read_history( $historyFile );
+ } else {
+ $historyFile = null;
+ }
- function cb() {
- return array( $this, 'printPrompt' );
+ $wholeLine = '';
+ $newPrompt = '> ';
+ $prompt = $newPrompt;
+ $doDie = !Maintenance::posix_isatty( 0 );
+ while ( ( $line = Maintenance::readconsole( $prompt ) ) !== false ) {
+ if ( !$line ) {
+ # User simply pressed return key
+ continue;
+ }
+ $done = $db->streamStatementEnd( $wholeLine, $line );
+
+ $wholeLine .= $line;
+
+ if ( !$done ) {
+ $wholeLine .= ' ';
+ $prompt = ' -> ';
+ continue;
+ }
+ if ( $historyFile ) {
+ # Delimiter is eated by streamStatementEnd, we add it
+ # up in the history (T39020)
+ readline_add_history( $wholeLine . ';' );
+ readline_write_history( $historyFile );
+ }
+ $this->sqlDoQuery( $db, $wholeLine, $doDie );
+ $prompt = $newPrompt;
+ $wholeLine = '';
+ }
+ wfWaitForSlaves();
}
- function printPrompt() {
- echo $this->prompt;
+ protected function sqlDoQuery( IDatabase $db, $line, $dieOnError ) {
+ try {
+ $res = $db->query( $line );
+ $this->sqlPrintResult( $res, $db );
+ } catch ( DBQueryError $e ) {
+ $this->error( $e, $dieOnError );
+ }
}
-}
-function sqlPrintResult( $res, $db ) {
- if ( !$res ) {
- // Do nothing
- } elseif ( is_object( $res ) && $res->numRows() ) {
- while ( $row = $res->fetchObject() ) {
- print_r( $row );
+ /**
+ * Print the results, callback for $db->sourceStream()
+ * @param ResultWrapper|bool $res The results object
+ * @param IDatabase $db
+ */
+ 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" );
}
- } else {
- $affected = $db->affectedRows();
- echo "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;
scripts.mit.edu / autoinstallsdev / mediawiki.git / blobdiff