Go to the documentation of this file.
25 require_once __DIR__ .
'/Maintenance.php';
39 parent::__construct();
40 $this->
addDescription(
'Send SQL queries to a MediaWiki database. ' .
41 'Takes a file name containing SQL as argument or runs interactively.' );
43 'Run a single query instead of running interactively',
false,
true );
44 $this->
addOption(
'json',
'Output the results as JSON instead of PHP objects' );
45 $this->
addOption(
'status',
'Return successful exit status only if the query succeeded '
46 .
'(selected or altered rows), otherwise 1 for errors, 2 for no rows' );
47 $this->
addOption(
'cluster',
'Use an external cluster by name',
false,
true );
49 'The database wiki ID to use if not the current one',
false,
true );
51 'Replica DB server to use instead of the master DB (can be "any")',
false,
true );
60 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
62 $lb = $lbFactory->getExternalLB( $this->
getOption(
'cluster' ) );
64 $lb = $lbFactory->getMainLB( $wiki );
68 if ( $replicaDB ===
'any' ) {
70 } elseif ( $replicaDB !=
'' ) {
72 $serverCount = $lb->getServerCount();
73 for ( $i = 0; $i < $serverCount; ++$i ) {
74 if ( $lb->getServerName( $i ) === $replicaDB ) {
79 if ( $index ===
null ) {
80 $this->
fatalError(
"No replica DB server configured with the name '$replicaDB'." );
87 $db = $lb->getConnection( $index, [], $wiki );
88 if ( $replicaDB !=
'' && $db->getLBInfo(
'master' ) !==
null ) {
89 $this->
fatalError(
"The server selected ({$db->getServer()}) is not a replica DB." );
94 $db->setSchemaVars(
$updater->getSchemaVars() );
97 if ( $this->
hasArg( 0 ) ) {
100 $this->
fatalError(
"Unable to open input file" );
103 $error = $db->sourceStream(
$file,
null, [ $this,
'sqlPrintResult' ] );
104 if ( $error !==
true ) {
116 exit(
$res ? 0 : 2 );
122 function_exists(
'readline_add_history' ) &&
125 $historyFile = isset( $_ENV[
'HOME'] ) ?
126 "{$_ENV['HOME']}/.mwsql_history" :
"$IP/maintenance/.mwsql_history";
127 readline_read_history( $historyFile );
134 $prompt = $newPrompt;
139 # User simply pressed return key
142 $done = $db->streamStatementEnd( $wholeLine,
$line );
151 if ( $historyFile ) {
152 # Delimiter is eated by streamStatementEnd, we add it
153 # up in the history (T39020)
154 readline_add_history( $wholeLine .
';' );
155 readline_write_history( $historyFile );
158 $prompt = $newPrompt;
163 exit(
$res ? 0 : 2 );
197 } elseif ( is_object(
$res ) ) {
200 foreach (
$res as $row ) {
201 $out .= print_r( $row,
true );
205 $out = json_encode(
$rows, JSON_PRETTY_PRINT );
206 } elseif ( !
$rows ) {
207 $out =
'Query OK, 0 row(s) affected';
212 $affected = $db->affectedRows();
214 $this->
output( json_encode( [
'affected' => $affected ], JSON_PRETTY_PRINT ) .
"\n" );
216 $this->
output(
"Query OK, $affected row(s) affected\n" );
sqlDoQuery(IDatabase $db, $line, $dieOnError)
static newForDB(IMaintainableDatabase $db, $shared=false, Maintenance $maintenance=null)
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
__construct()
Default constructor.
sqlPrintResult( $res, $db)
Print the results, callback for $db->sourceStream()
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
addDescription( $text)
Set the description text.
static readconsole( $prompt='> ')
Prompt the console for input.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
require_once RUN_MAINTENANCE_IF_MAIN
hasArg( $argId=0)
Does a given argument exist?
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
wfWaitForSlaves( $ifWritesSince=null, $wiki=false, $cluster=false, $timeout=null)
Waits for the replica DBs to catch up to the master position.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
null for the wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
execute()
Do the actual work.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Maintenance script that sends SQL queries from the specified file to the database.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
static posix_isatty( $fd)
Wrapper for posix_isatty() We default as considering stdin a tty (for nice readline methods) but trea...
getOption( $name, $default=null)
Get an option, or return the default.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction $rows
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
$page->newPageUpdater($user) $updater
error( $err, $die=0)
Throw an error to the user.
output( $out, $channel=null)
Throw some output to the user.
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
hasOption( $name)
Checks to see if a particular option exists.
getArg( $argId=0, $default=null)
Get an argument.