25require_once __DIR__ .
'/Maintenance.php';
38 parent::__construct();
39 $this->
addDescription(
'Send SQL queries to a MediaWiki database. ' .
40 'Takes a file name containing SQL as argument or runs interactively.' );
42 'Run a single query instead of running interactively',
false,
true );
43 $this->
addOption(
'cluster',
'Use an external cluster by name',
false,
true );
45 'The database wiki ID to use if not the current one',
false,
true );
47 'Replica DB server to use instead of the master DB (can be "any")',
false,
true );
63 if ( $replicaDB ===
'any' ) {
65 } elseif ( $replicaDB !=
'' ) {
67 $serverCount = $lb->getServerCount();
68 for ( $i = 0; $i < $serverCount; ++$i ) {
69 if ( $lb->getServerName( $i ) === $replicaDB ) {
74 if ( $index ===
null ) {
75 $this->
error(
"No replica DB server configured with the name '$replicaDB'.", 1 );
82 $db = $lb->getConnection( $index, [], $wiki );
83 if ( $replicaDB !=
'' && $db->getLBInfo(
'master' ) !==
null ) {
84 $this->
error(
"The server selected ({$db->getServer()}) is not a replica DB.", 1 );
89 $db->setSchemaVars( $updater->getSchemaVars() );
92 if ( $this->
hasArg( 0 ) ) {
93 $file = fopen( $this->
getArg( 0 ),
'r' );
95 $this->
error(
"Unable to open input file",
true );
98 $error = $db->sourceStream( $file,
null, [ $this,
'sqlPrintResult' ] );
99 if ( $error !==
true ) {
100 $this->
error( $error,
true );
114 function_exists(
'readline_add_history' ) &&
117 $historyFile = isset( $_ENV[
'HOME'] ) ?
118 "{$_ENV['HOME']}/.mwsql_history" :
"$IP/maintenance/.mwsql_history";
119 readline_read_history( $historyFile );
126 $prompt = $newPrompt;
130 # User simply pressed return key
133 $done = $db->streamStatementEnd( $wholeLine,
$line );
142 if ( $historyFile ) {
143 # Delimiter is eated by streamStatementEnd, we add it
144 # up in the history (T39020)
145 readline_add_history( $wholeLine .
';' );
146 readline_write_history( $historyFile );
149 $prompt = $newPrompt;
160 $this->
error( $e, $dieOnError );
173 } elseif ( is_object(
$res ) &&
$res->numRows() ) {
174 foreach (
$res as $row ) {
175 $this->
output( print_r( $row,
true ) );
178 $affected = $db->affectedRows();
179 $this->
output(
"Query OK, $affected row(s) affected\n" );
wfWaitForSlaves( $ifWritesSince=null, $wiki=false, $cluster=false, $timeout=null)
Waits for the replica DBs to catch up to the master position.
wfGetLB( $wiki=false)
Get a load balancer object.
wfGetLBFactory()
Get the load balancer factory object.
static newForDB(Database $db, $shared=false, $maintenance=null)
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
hasArg( $argId=0)
Does a given argument exist?
hasOption( $name)
Checks to see if a particular param exists.
static readconsole( $prompt='> ')
Prompt the console for input.
static posix_isatty( $fd)
Wrapper for posix_isatty() We default as considering stdin a tty (for nice readline methods) but trea...
getArg( $argId=0, $default=null)
Get an argument.
addDescription( $text)
Set the description text.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
getOption( $name, $default=null)
Get an option, or return the default.
Maintenance script that sends SQL queries from the specified file to the database.
sqlPrintResult( $res, $db)
Print the results, callback for $db->sourceStream()
__construct()
Default constructor.
sqlDoQuery(IDatabase $db, $line, $dieOnError)
execute()
Do the actual work.
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling output() to send it all. It could be easily changed to send incrementally if that becomes useful
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 error
null for the local 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
returning false will NOT prevent logging $e
require_once RUN_MAINTENANCE_IF_MAIN