MediaWiki  master
BackupDumper Class Reference
Inheritance diagram for BackupDumper:
Collaboration diagram for BackupDumper:

Public Member Functions

 __construct ( $args=null)
 
 __destruct ()
 
 backupDb ()
 
 backupServer ()
 
 dump ( $history, $text=WikiExporter::TEXT)
 
 execute ()
 
 initProgress ( $history=WikiExporter::FULL)
 Initialise starting time and maximum revision count. More...
 
 loadPlugin ( $class, $file)
 Load a plugin and register it. More...
 
 processOptions ()
 Processes arguments and sets $this->$sink accordingly. More...
 
 progress ( $string)
 
 registerFilter ( $name, $class)
 
 registerOutput ( $name, $class)
 
 report ( $final=false)
 
 reportPage ()
 
 revCount ()
 
 setDB (IMaintainableDatabase $db)
 Force the dump to use the provided database connection for database operations, wherever possible. More...
 
 showReport ()
 
- Public Member Functions inherited from Maintenance
 __construct ()
 Default constructor. More...
 
 checkRequiredExtensions ()
 Verify that the required extensions are installed. More...
 
 cleanupChanneled ()
 Clean up channeled output. More...
 
 clearParamsAndArgs ()
 Clear all params and arguments. More...
 
 execute ()
 Do the actual work. More...
 
 finalSetup ()
 Handle some last-minute setup here. More...
 
 getConfig ()
 
 getDbType ()
 Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB. More...
 
 getName ()
 Get the script's name. More...
 
 globals ()
 Potentially debug globals. More...
 
 isQuiet ()
 
 loadParamsAndArgs ( $self=null, $opts=null, $args=null)
 Process command line arguments $mOptions becomes an array with keys set to the option names $mArgs becomes a zero-based array containing the non-option arguments. More...
 
 loadSettings ()
 Generic setup for most installs. More...
 
 loadWithArgv ( $argv)
 Load params and arguments from a given array of command-line arguments. More...
 
 memoryLimit ()
 Normally we disable the memory_limit when running admin scripts. More...
 
 outputChanneled ( $msg, $channel=null)
 Message outputter with channeled message support. More...
 
 purgeRedundantText ( $delete=true)
 Support function for cleaning up redundant text records. More...
 
 runChild ( $maintClass, $classFile=null)
 Run a child maintenance script. More...
 
 setAgentAndTriggers ()
 Set triggers like when to try to run deferred updates. More...
 
 setConfig (Config $config)
 
 setDB (IMaintainableDatabase $db)
 Sets database object to be returned by getDB(). More...
 
 setup ()
 Do some sanity checking and basic setup. More...
 
 updateSearchIndex ( $maxLockTime, $callback, $dbw, $results)
 Perform a search index update with locking. More...
 
 updateSearchIndexForPage ( $dbw, $pageId)
 Update the searchindex table for a given pageid. More...
 
 validateParamsAndArgs ()
 Run some validation checks on the params, etc. More...
 

Public Attributes

 $dumpUploadFileContents = false
 
 $dumpUploads = false
 
 $endId = 0
 
 $limitNamespaces = []
 
 $orderRevs = false
 
 $pages = null
 
 $reporting = true
 
 $revEndId = 0
 
 $revStartId = 0
 
 $skipFooter = false
 
 $skipHeader = false
 
 $startId = 0
 
- Public Attributes inherited from Maintenance
resource $fileHandle
 Used when creating separate schema files. More...
 
 $mDbPass
 
array $orderedOptions = []
 Used to read the options in the order they were passed. More...
 
const DB_ADMIN = 2
 
const DB_NONE = 0
 Constants for DB access type. More...
 
const DB_STD = 1
 
const STDIN_ALL = 'all'
 

Protected Attributes

 $filterTypes = []
 
IMaintainableDatabase null $forcedDb = null
 The dependency-injected database to use. More...
 
 $ID = 0
 
 $lastTime = 0
 
LoadBalancer $lb
 
 $outputTypes = []
 
 $pageCount = 0
 
 $pageCountLast = 0
 
 $reportingInterval = 100
 
 $revCount = 0
 
 $revCountLast = 0
 
 $schemaVersion = null
 
 $server = null
 
 $sink = null
 
- Protected Attributes inherited from Maintenance
 $mAllowUnregisteredOptions = false
 
 $mArgList = []
 
 $mArgs = []
 
int $mBatchSize = null
 Batch size. More...
 
 $mDbUser
 
 $mDescription = ''
 
 $mInputLoaded = false
 
 $mOptions = []
 
 $mParams = []
 
 $mQuiet = false
 
 $mSelf
 
 $mShortParamsMap = []
 

Additional Inherited Members

- Static Public Member Functions inherited from Maintenance
static getTermSize ()
 Get the terminal size as a two-element array where the first element is the width (number of columns) and the second element is the height (number of rows). More...
 
static posix_isatty ( $fd)
 Wrapper for posix_isatty() We default as considering stdin a tty (for nice readline methods) but treating stout as not a tty to avoid color codes. More...
 
static readconsole ( $prompt='> ')
 Prompt the console for input. More...
 
static requireTestsAutoloader ()
 Call this to set up the autoloader to allow classes to be used from the tests directory. More...
 
static setLBFactoryTriggers (LBFactory $LBFactory, Config $config)
 
static shouldExecute ()
 Should we execute the maintenance script, or just allow it to be included as a standalone class? It checks that the call stack only includes this function and "requires" (meaning was called from the file scope) More...
 
- Protected Member Functions inherited from Maintenance
 activateProfiler ()
 Activate the profiler (assuming $wgProfiler is set) More...
 
 addArg ( $arg, $description, $required=true)
 Add some args that are needed. More...
 
 addDefaultParams ()
 Add the default parameters to the scripts. More...
 
 addDescription ( $text)
 Set the description text. More...
 
 addOption ( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
 Add a parameter to the script. More...
 
 adjustMemoryLimit ()
 Adjusts PHP's memory limit to better suit our needs, if needed. More...
 
 afterFinalSetup ()
 Execute a callback function at the end of initialisation. More...
 
 beginTransaction (IDatabase $dbw, $fname)
 Begin a transcation on a DB. More...
 
 commitTransaction (IDatabase $dbw, $fname)
 Commit the transcation on a DB handle and wait for replica DBs to catch up. More...
 
 countDown ( $seconds)
 Count down from $seconds to zero on the terminal, with a one-second pause between showing each number. More...
 
 deleteOption ( $name)
 Remove an option. More...
 
 error ( $err, $die=0)
 Throw an error to the user. More...
 
 fatalError ( $msg, $exitCode=1)
 Output a message and terminate the current script. More...
 
 getArg ( $argId=0, $default=null)
 Get an argument. More...
 
 getBatchSize ()
 Returns batch size. More...
 
 getDB ( $db, $groups=[], $dbDomain=false)
 Returns a database to be used by current maintenance script. More...
 
 getDir ()
 Get the maintenance directory. More...
 
 getOption ( $name, $default=null)
 Get an option, or return the default. More...
 
 getStdin ( $len=null)
 Return input from stdin. More...
 
 hasArg ( $argId=0)
 Does a given argument exist? More...
 
 hasOption ( $name)
 Checks to see if a particular option exists. More...
 
 loadSpecialVars ()
 Handle the special variables that are global to all scripts. More...
 
 maybeHelp ( $force=false)
 Maybe show the help. More...
 
 output ( $out, $channel=null)
 Throw some output to the user. More...
 
 requireExtension ( $name)
 Indicate that the specified extension must be loaded before the script can run. More...
 
 rollbackTransaction (IDatabase $dbw, $fname)
 Rollback the transcation on a DB handle. More...
 
 setAllowUnregisteredOptions ( $allow)
 Sets whether to allow unregistered options, which are options passed to a script that do not match an expected parameter. More...
 
 setBatchSize ( $s=0)
 Set the batch size. More...
 
 supportsOption ( $name)
 Checks to see if a particular option in supported. More...
 

Detailed Description

Definition at line 39 of file BackupDumper.php.

Constructor & Destructor Documentation

◆ __construct()

BackupDumper::__construct (   $args = null)
Parameters
array | null$argsFor backward compatibility

Definition at line 83 of file BackupDumper.php.

References $args, Maintenance\addOption(), class, Maintenance\loadWithArgv(), processOptions(), registerFilter(), registerOutput(), and WikiExporter\schemaVersion().

◆ __destruct()

BackupDumper::__destruct ( )

Definition at line 360 of file BackupDumper.php.

Member Function Documentation

◆ backupDb()

BackupDumper::backupDb ( )
Todo:
Fixme: the –server parameter is currently not respected, as it doesn't seem terribly easy to ask the load balancer for a particular connection by name.
Returns
IMaintainableDatabase

Definition at line 333 of file BackupDumper.php.

References $forcedDb, DB_REPLICA, null, and Wikimedia\Rdbms\IDatabase\setSessionOptions().

Referenced by dump().

◆ backupServer()

BackupDumper::backupServer ( )

Definition at line 366 of file BackupDumper.php.

References $wgDBserver, and server.

◆ dump()

BackupDumper::dump (   $history,
  $text = WikiExporter::TEXT 
)

◆ execute()

BackupDumper::execute ( )

Definition at line 153 of file BackupDumper.php.

◆ initProgress()

BackupDumper::initProgress (   $history = WikiExporter::FULL)

Initialise starting time and maximum revision count.

We'll make ETA calculations based an progress, assuming relatively constant per-revision rate.

Parameters
int$historyWikiExporter::CURRENT or WikiExporter::FULL

Definition at line 313 of file BackupDumper.php.

References $dbr, $forcedDb, WikiExporter\CURRENT, DB_REPLICA, Maintenance\getDB(), and null.

Referenced by dump().

◆ loadPlugin()

BackupDumper::loadPlugin (   $class,
  $file 
)

Load a plugin and register it.

Parameters
string$className of plugin class; must have a static 'register' method that takes a BackupDumper as a parameter.
string$fileFull or relative path to the PHP file to load, or empty

Definition at line 145 of file BackupDumper.php.

References $file.

Referenced by processOptions().

◆ processOptions()

BackupDumper::processOptions ( )

◆ progress()

◆ registerFilter()

BackupDumper::registerFilter (   $name,
  $class 
)
Parameters
string$name
string$className of filter plugin class

Definition at line 134 of file BackupDumper.php.

References $name.

Referenced by __construct().

◆ registerOutput()

BackupDumper::registerOutput (   $name,
  $class 
)
Parameters
string$name
string$className of output filter plugin class

Definition at line 126 of file BackupDumper.php.

References $name.

Referenced by __construct().

◆ report()

BackupDumper::report (   $final = false)

Definition at line 381 of file BackupDumper.php.

References revCount(), and showReport().

Referenced by TextPassDumper\dump(), dump(), and revCount().

◆ reportPage()

BackupDumper::reportPage ( )

Definition at line 372 of file BackupDumper.php.

◆ revCount()

BackupDumper::revCount ( )

Definition at line 376 of file BackupDumper.php.

References report().

Referenced by report(), TextPassDumper\showReport(), and showReport().

◆ setDB()

BackupDumper::setDB ( IMaintainableDatabase  $db)

Force the dump to use the provided database connection for database operations, wherever possible.

Parameters
IMaintainableDatabase$dbThe database connection to use

Definition at line 355 of file BackupDumper.php.

◆ showReport()

BackupDumper::showReport ( )

Member Data Documentation

◆ $dumpUploadFileContents

BackupDumper::$dumpUploadFileContents = false

Definition at line 49 of file BackupDumper.php.

Referenced by dump().

◆ $dumpUploads

BackupDumper::$dumpUploads = false

Definition at line 48 of file BackupDumper.php.

Referenced by dump().

◆ $endId

BackupDumper::$endId = 0

Definition at line 45 of file BackupDumper.php.

◆ $filterTypes

BackupDumper::$filterTypes = []
protected

Definition at line 64 of file BackupDumper.php.

◆ $forcedDb

IMaintainableDatabase null BackupDumper::$forcedDb = null
protected

The dependency-injected database to use.

See also
self::setDB

Definition at line 75 of file BackupDumper.php.

Referenced by backupDb(), initProgress(), and TextPassDumper\rotateDb().

◆ $ID

BackupDumper::$ID = 0
protected

Definition at line 66 of file BackupDumper.php.

◆ $lastTime

BackupDumper::$lastTime = 0
protected

◆ $lb

LoadBalancer BackupDumper::$lb
protected

Definition at line 78 of file BackupDumper.php.

◆ $limitNamespaces

BackupDumper::$limitNamespaces = []

Definition at line 51 of file BackupDumper.php.

◆ $orderRevs

BackupDumper::$orderRevs = false

Definition at line 50 of file BackupDumper.php.

◆ $outputTypes

BackupDumper::$outputTypes = []
protected

Definition at line 63 of file BackupDumper.php.

◆ $pageCount

BackupDumper::$pageCount = 0
protected

Definition at line 54 of file BackupDumper.php.

◆ $pageCountLast

BackupDumper::$pageCountLast = 0
protected

Definition at line 60 of file BackupDumper.php.

Referenced by TextPassDumper\showReport(), and showReport().

◆ $pages

BackupDumper::$pages = null

Definition at line 41 of file BackupDumper.php.

Referenced by DumpBackup\processOptions().

◆ $reporting

BackupDumper::$reporting = true

Definition at line 40 of file BackupDumper.php.

◆ $reportingInterval

BackupDumper::$reportingInterval = 100
protected

Definition at line 53 of file BackupDumper.php.

◆ $revCount

BackupDumper::$revCount = 0
protected

Definition at line 55 of file BackupDumper.php.

Referenced by TextPassDumper\showReport(), and showReport().

◆ $revCountLast

BackupDumper::$revCountLast = 0
protected

Definition at line 61 of file BackupDumper.php.

Referenced by TextPassDumper\showReport(), and showReport().

◆ $revEndId

BackupDumper::$revEndId = 0

Definition at line 47 of file BackupDumper.php.

◆ $revStartId

BackupDumper::$revStartId = 0

Definition at line 46 of file BackupDumper.php.

◆ $schemaVersion

BackupDumper::$schemaVersion = null
protected

Definition at line 56 of file BackupDumper.php.

◆ $server

BackupDumper::$server = null
protected

Definition at line 57 of file BackupDumper.php.

◆ $sink

BackupDumper::$sink = null
protected

Definition at line 58 of file BackupDumper.php.

Referenced by processOptions().

◆ $skipFooter

BackupDumper::$skipFooter = false

Definition at line 43 of file BackupDumper.php.

◆ $skipHeader

BackupDumper::$skipHeader = false

Definition at line 42 of file BackupDumper.php.

◆ $startId

BackupDumper::$startId = 0

Definition at line 44 of file BackupDumper.php.


The documentation for this class was generated from the following file: