MediaWiki master
MediaWiki\Maintenance\BackupDumper Class Reference

Inherits MediaWiki\Maintenance\Maintenance.

Inherited by DumpBackup, and MediaWiki\Maintenance\TextPassDumper.

Collaboration diagram for MediaWiki\Maintenance\BackupDumper:

Public Member Functions

 __construct ( $args=null)
 
 dump ( $history, $text=WikiExporter::TEXT)
 
 finalSetup (SettingsBuilder $settingsBuilder)
 Handle some last-minute setup here.
 
 initProgress ( $history=WikiExporter::FULL)
 Initialise starting time and maximum revision count.
 
 loadPlugin ( $class, $file)
 Load a plugin and register it.
 
 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.
 
 showReport ()
 
- Public Member Functions inherited from MediaWiki\Maintenance\Maintenance
 __construct ()
 Default constructor.
 
 canExecuteWithoutLocalSettings ()
 Whether this script can run without LocalSettings.php.
 
 checkRequiredExtensions ()
 Verify that the required extensions are installed.
 
 cleanupChanneled ()
 Clean up channeled output.
 
 clearParamsAndArgs ()
 Clear all params and arguments.
 
 createChild (string $maintClass, ?string $classFile=null)
 Returns an instance of the given maintenance script, with all of the current arguments passed to it.
 
 execute ()
 Do the actual work.
 
 getConfig ()
 
 getDbType ()
 Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB.
 
 getName ()
 Get the script's name.
 
 getParameters ()
 
 isQuiet ()
 
 loadParamsAndArgs ( $self=null, $opts=null, $args=null)
 Process command line arguments when running as a child script.
 
 loadWithArgv ( $argv)
 Load params and arguments from a given array of command-line arguments.
 
 memoryLimit ()
 Normally we disable the memory_limit when running admin scripts.
 
 outputChanneled ( $msg, $channel=null)
 Message outputter with channeled message support.
 
 purgeRedundantText ( $delete=true)
 Support function for cleaning up redundant text records.
 
 runChild ( $maintClass, $classFile=null)
 Returns an instance of the given maintenance script, with all of the current arguments passed to it.
 
 setArg ( $argId, $value)
 Programmatically set the value of the given argument.
 
 setConfig (Config $config)
 
 setLBFactory (ILBFactory $lbFactory)
 
 setName (string $name)
 
 setOption (string $name, $value)
 Programmatically set the value of the given option.
 
 setup ()
 Provides subclasses with an opportunity to perform initial checks.
 
 validateParamsAndArgs ()
 Run some validation checks on the params, etc.
 

Public Attributes

bool $dumpUploadFileContents = false
 
bool $dumpUploads = false
 
int $endId = 0
 
array null $limitNamespaces = []
 
bool $orderRevs = false
 
string[] null $pages = null
 null means all pages
 
bool $reporting = true
 
int $revEndId = 0
 
int $revStartId = 0
 
bool $skipFooter = false
 don't output </mediawiki>
 
bool $skipHeader = false
 don't output <mediawiki> and <siteinfo>
 
int $startId = 0
 
resource false $stderr
 
- Public Attributes inherited from MediaWiki\Maintenance\Maintenance
resource null $fileHandle
 Used when creating separate schema files.
 
array $orderedOptions = []
 Used to read the options in the order they were passed.
 
const DB_ADMIN = 2
 
const DB_NONE = 0
 Constants for DB access type.
 
const DB_STD = 1
 
const GENERIC_MAINTENANCE_PARAMETERS = 'Script runner options'
 
const SCRIPT_DEPENDENT_PARAMETERS = 'Common options'
 
const STDIN_ALL = -1
 

Protected Member Functions

 getBackupDatabase ()
 
 processOptions ()
 Processes arguments and sets $this->$sink accordingly.
 
 progress ( $string)
 
- Protected Member Functions inherited from MediaWiki\Maintenance\Maintenance
 addArg ( $arg, $description, $required=true, $multi=false)
 Add some args that are needed.
 
 addDefaultParams ()
 Add the default parameters to the scripts.
 
 addDescription ( $text)
 Set the description text.
 
 addOption ( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
 Add a parameter to the script.
 
 afterFinalSetup ()
 Override to perform any required operation at the end of initialisation.
 
 beginTransaction (IDatabase $dbw, $fname)
 Begin a transaction on a DB handle.
 
 beginTransactionRound ( $fname)
 Start a transactional batch of DB operations.
 
 commitTransaction (IDatabase $dbw, $fname)
 Commit the transaction on a DB handle and wait for replica DB servers to catch up.
 
 commitTransactionRound ( $fname)
 Commit a transactional batch of DB operations and wait for replica DB servers to catch up.
 
 countDown ( $seconds)
 Count down from $seconds to zero on the terminal, with a one-second pause between showing each number.
 
 deleteOption ( $name)
 Remove an option.
 
 error ( $err, $die=0)
 Throw an error to the user.
 
 fatalError ( $msg, $exitCode=1)
 Output a message and terminate the current script.
 
 getArg ( $argId=0, $default=null)
 Get an argument.
 
 getArgName (int $argId)
 Get the name of an argument.
 
 getArgs ( $offset=0)
 Get arguments.
 
 getBatchSize ()
 Returns batch size.
 
 getDB ( $db, $groups=[], $dbDomain=false)
 Returns a database to be used by current maintenance script.
 
 getDir ()
 Get the maintenance directory.
 
 getHookContainer ()
 Get a HookContainer, for running extension hooks or for hook metadata.
 
 getHookRunner ()
 Get a HookRunner for running core hooks.
 
 getOption ( $name, $default=null)
 Get an option, or return the default.
 
 getPrimaryDB ()
 
 getReplicaDB ()
 
 getServiceContainer ()
 Returns the main service container.
 
 getStdin ( $len=null)
 Return input from stdin.
 
 hasArg ( $argId=0)
 Does a given argument exist?
 
 hasOption ( $name)
 Checks to see if a particular option was set.
 
 loadSpecialVars ()
 Handle the special variables that are global to all scripts.
 
 maybeHelp ( $force=false)
 Maybe show the help.
 
 newBatchIterator ( $source)
 Wrap an entry iterator into a generator that returns batches of said entries.
 
 output ( $out, $channel=null)
 Throw some output to the user.
 
 parseIntList ( $text)
 Utility function to parse a string (perhaps from a command line option) into a list of integers (perhaps some kind of numeric IDs).
 
 prompt (string $prompt, ?string $default=null)
 
 requireExtension ( $name)
 Indicate that the specified extension must be loaded before the script can run.
 
 rollbackTransaction (IDatabase $dbw, $fname)
 Rollback the transaction on a DB handle.
 
 rollbackTransactionRound ( $fname)
 Rollback a transactional batch of DB operations.
 
 setAllowUnregisteredOptions ( $allow)
 Sets whether to allow unregistered options, which are options passed to a script that do not match an expected parameter.
 
 setBatchSize ( $s=0)
 
 showHelp ()
 Definitely show the help.
 
 supportsOption ( $name)
 Checks to see if a particular option in supported.
 
 validateUserOption ( $errorMsg)
 
 waitForReplication ()
 Wait for replica DB servers to catch up.
 

Protected Attributes

bool $atStart
 
string $buffer
 
ExportProgressFilter $egress
 
string[] $filterTypes = []
 
IMaintainableDatabase null $forcedDb = null
 The dependency-injected database to use.
 
int $ID = 0
 
string $lastName
 
float $lastTime = 0
 
int $maxCount
 
array false $openElement
 
string[] $outputTypes = []
 
int $pageCount = 0
 
int $pageCountLast = 0
 
int $pageCountPart
 
int $reportingInterval = 100
 
int $revCount = 0
 
int $revCountLast = 0
 
int $revCountPart
 
string null $schemaVersion = null
 null means use default
 
DumpMultiWriter DumpOutput null $sink = null
 Output filters.
 
float $startTime
 
string $state
 
string null $thisRevFormat
 
string null $thisRevModel
 
float $timeOfCheckpoint
 
- Protected Attributes inherited from MediaWiki\Maintenance\Maintenance
array $mArgs = []
 This is the list of arguments that were actually passed.
 
int null $mBatchSize = null
 Batch size.
 
string $mDbPass = null
 
string $mDbUser = null
 
string $mDescription = ''
 A description of the script, children should change this via addDescription()
 
bool $mInputLoaded = false
 Have we already loaded our user input?
 
array $mOptions = []
 This is the list of options that were actually passed.
 
array[] $mParams = []
 Empty.
 
bool $mQuiet = false
 Special vars for params that are always used.
 
string null $mSelf
 Name of the script currently running.
 
MaintenanceParameters $parameters
 

Additional Inherited Members

- Static Public Member Functions inherited from MediaWiki\Maintenance\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).
 
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.
 
static readconsole ( $prompt='> ')
 Prompt the console for input.
 
static requireTestsAutoloader ()
 Call this to set up the autoloader to allow classes to be used from the tests directory.
 

Detailed Description

Definition at line 50 of file BackupDumper.php.

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ dump()

◆ finalSetup()

MediaWiki\Maintenance\BackupDumper::finalSetup ( SettingsBuilder $settingsBuilder)

Handle some last-minute setup here.

Stability: stable
to override
Parameters
SettingsBuilder$settingsBuilder

Reimplemented from MediaWiki\Maintenance\Maintenance.

Reimplemented in MediaWiki\Maintenance\TextPassDumper.

Definition at line 182 of file BackupDumper.php.

References MediaWiki\Maintenance\BackupDumper\$schemaVersion, MediaWiki\Maintenance\Maintenance\addOption(), MediaWiki\Settings\SettingsBuilder\getConfig(), and MediaWiki\MainConfigNames\XmlDumpSchemaVersion.

◆ getBackupDatabase()

MediaWiki\Maintenance\BackupDumper::getBackupDatabase ( )
protected

◆ initProgress()

MediaWiki\Maintenance\BackupDumper::initProgress ( $history = WikiExporter::FULL)

Initialise starting time and maximum revision count.

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

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

Reimplemented in MediaWiki\Maintenance\TextPassDumper.

Definition at line 373 of file BackupDumper.php.

References MediaWiki\Maintenance\BackupDumper\$forcedDb, MediaWiki\Maintenance\BackupDumper\$startTime, DB_REPLICA, and MediaWiki\Maintenance\Maintenance\getDB().

Referenced by MediaWiki\Maintenance\BackupDumper\dump().

◆ loadPlugin()

MediaWiki\Maintenance\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 214 of file BackupDumper.php.

Referenced by MediaWiki\Maintenance\BackupDumper\processOptions().

◆ processOptions()

◆ progress()

◆ registerFilter()

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

Definition at line 203 of file BackupDumper.php.

Referenced by MediaWiki\Maintenance\BackupDumper\__construct().

◆ registerOutput()

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

Definition at line 195 of file BackupDumper.php.

Referenced by MediaWiki\Maintenance\BackupDumper\__construct().

◆ report()

◆ reportPage()

MediaWiki\Maintenance\BackupDumper::reportPage ( )

Definition at line 421 of file BackupDumper.php.

◆ revCount()

◆ setDB()

MediaWiki\Maintenance\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

Reimplemented from MediaWiki\Maintenance\Maintenance.

Definition at line 416 of file BackupDumper.php.

◆ showReport()

Member Data Documentation

◆ $atStart

bool MediaWiki\Maintenance\BackupDumper::$atStart
protected

Definition at line 120 of file BackupDumper.php.

◆ $buffer

string MediaWiki\Maintenance\BackupDumper::$buffer
protected

Definition at line 116 of file BackupDumper.php.

◆ $dumpUploadFileContents

bool MediaWiki\Maintenance\BackupDumper::$dumpUploadFileContents = false

Definition at line 70 of file BackupDumper.php.

Referenced by MediaWiki\Maintenance\BackupDumper\dump().

◆ $dumpUploads

bool MediaWiki\Maintenance\BackupDumper::$dumpUploads = false

Definition at line 68 of file BackupDumper.php.

Referenced by MediaWiki\Maintenance\BackupDumper\dump().

◆ $egress

ExportProgressFilter MediaWiki\Maintenance\BackupDumper::$egress
protected

Definition at line 114 of file BackupDumper.php.

◆ $endId

int MediaWiki\Maintenance\BackupDumper::$endId = 0

Definition at line 62 of file BackupDumper.php.

◆ $filterTypes

string [] MediaWiki\Maintenance\BackupDumper::$filterTypes = []
protected

Definition at line 98 of file BackupDumper.php.

◆ $forcedDb

IMaintainableDatabase null MediaWiki\Maintenance\BackupDumper::$forcedDb = null
protected

The dependency-injected database to use.

See also
self::setDB

Definition at line 137 of file BackupDumper.php.

Referenced by MediaWiki\Maintenance\BackupDumper\getBackupDatabase(), and MediaWiki\Maintenance\BackupDumper\initProgress().

◆ $ID

int MediaWiki\Maintenance\BackupDumper::$ID = 0
protected

Definition at line 101 of file BackupDumper.php.

◆ $lastName

string MediaWiki\Maintenance\BackupDumper::$lastName
protected

Definition at line 126 of file BackupDumper.php.

◆ $lastTime

float MediaWiki\Maintenance\BackupDumper::$lastTime = 0
protected

◆ $limitNamespaces

array null MediaWiki\Maintenance\BackupDumper::$limitNamespaces = []

Definition at line 74 of file BackupDumper.php.

◆ $maxCount

int MediaWiki\Maintenance\BackupDumper::$maxCount
protected

◆ $openElement

array false MediaWiki\Maintenance\BackupDumper::$openElement
protected

Definition at line 118 of file BackupDumper.php.

◆ $orderRevs

bool MediaWiki\Maintenance\BackupDumper::$orderRevs = false

Definition at line 72 of file BackupDumper.php.

◆ $outputTypes

string [] MediaWiki\Maintenance\BackupDumper::$outputTypes = []
protected

Definition at line 96 of file BackupDumper.php.

◆ $pageCount

int MediaWiki\Maintenance\BackupDumper::$pageCount = 0
protected

Definition at line 81 of file BackupDumper.php.

◆ $pageCountLast

int MediaWiki\Maintenance\BackupDumper::$pageCountLast = 0
protected

◆ $pageCountPart

int MediaWiki\Maintenance\BackupDumper::$pageCountPart
protected

Definition at line 106 of file BackupDumper.php.

◆ $pages

string [] null MediaWiki\Maintenance\BackupDumper::$pages = null

null means all pages

Definition at line 54 of file BackupDumper.php.

Referenced by DumpBackup\processOptions().

◆ $reporting

bool MediaWiki\Maintenance\BackupDumper::$reporting = true

Definition at line 52 of file BackupDumper.php.

◆ $reportingInterval

int MediaWiki\Maintenance\BackupDumper::$reportingInterval = 100
protected

Definition at line 79 of file BackupDumper.php.

◆ $revCount

int MediaWiki\Maintenance\BackupDumper::$revCount = 0
protected

◆ $revCountLast

int MediaWiki\Maintenance\BackupDumper::$revCountLast = 0
protected

◆ $revCountPart

int MediaWiki\Maintenance\BackupDumper::$revCountPart
protected

Definition at line 108 of file BackupDumper.php.

◆ $revEndId

int MediaWiki\Maintenance\BackupDumper::$revEndId = 0

Definition at line 66 of file BackupDumper.php.

◆ $revStartId

int MediaWiki\Maintenance\BackupDumper::$revStartId = 0

Definition at line 64 of file BackupDumper.php.

◆ $schemaVersion

string null MediaWiki\Maintenance\BackupDumper::$schemaVersion = null
protected

null means use default

Definition at line 85 of file BackupDumper.php.

Referenced by MediaWiki\Maintenance\BackupDumper\finalSetup().

◆ $sink

DumpMultiWriter DumpOutput null MediaWiki\Maintenance\BackupDumper::$sink = null
protected

Output filters.

Definition at line 87 of file BackupDumper.php.

Referenced by MediaWiki\Maintenance\BackupDumper\processOptions().

◆ $skipFooter

bool MediaWiki\Maintenance\BackupDumper::$skipFooter = false

don't output </mediawiki>

Definition at line 58 of file BackupDumper.php.

◆ $skipHeader

bool MediaWiki\Maintenance\BackupDumper::$skipHeader = false

don't output <mediawiki> and <siteinfo>

Definition at line 56 of file BackupDumper.php.

◆ $startId

int MediaWiki\Maintenance\BackupDumper::$startId = 0

Definition at line 60 of file BackupDumper.php.

◆ $startTime

◆ $state

string MediaWiki\Maintenance\BackupDumper::$state
protected

Definition at line 128 of file BackupDumper.php.

◆ $stderr

resource false MediaWiki\Maintenance\BackupDumper::$stderr

Definition at line 76 of file BackupDumper.php.

◆ $thisRevFormat

string null MediaWiki\Maintenance\BackupDumper::$thisRevFormat
protected

Definition at line 124 of file BackupDumper.php.

◆ $thisRevModel

string null MediaWiki\Maintenance\BackupDumper::$thisRevModel
protected

Definition at line 122 of file BackupDumper.php.

◆ $timeOfCheckpoint

float MediaWiki\Maintenance\BackupDumper::$timeOfCheckpoint
protected

Definition at line 112 of file BackupDumper.php.


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