MediaWiki REL1_39
PopulateArchiveRevId Class Reference

Maintenance script that populares archive.ar_rev_id in old rows. More...

Inheritance diagram for PopulateArchiveRevId:
Collaboration diagram for PopulateArchiveRevId:

Public Member Functions

 __construct ()
 Default constructor.
- Public Member Functions inherited from LoggedUpdateMaintenance
 execute ()
 Do the actual work.
 setForce ( $forced=true)
 Sets whether a run of this maintenance script has the force parameter set.
- Public Member Functions inherited from Maintenance
 checkRequiredExtensions ()
 Verify that the required extensions are installed.
 cleanupChanneled ()
 Clean up channeled output.
 clearParamsAndArgs ()
 Clear all params and arguments.
 finalSetup (SettingsBuilder $settingsBuilder=null)
 Handle some last-minute setup here.
 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 ()
 globals ()
 Potentially debug globals.
 isQuiet ()
 loadParamsAndArgs ( $self=null, $opts=null, $args=null)
 Process command line arguments.
 loadSettings ()
 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)
 Run a child maintenance script.
 setAgentAndTriggers ()
 This method used to be for internal use by doMaintenance.php to apply some optional global state to LBFactory for debugging purposes.
 setArg ( $argId, $value)
 Programmatically set the value of the given argument.
 setConfig (Config $config)
 setDB (IMaintainableDatabase $db)
 Sets database object to be returned by getDB().
 setOption (string $name, $value)
 Programmatically set the value of the given option.
 setup ()
 Do some checking and basic setup.
 shutdown ()
 Call before exiting CLI process for the last DB commit, and flush any remaining buffers and other deferred work.
 validateParamsAndArgs ()
 Run some validation checks on the params, etc.

Static Public Member Functions

static checkMysqlAutoIncrementBug (IDatabase $dbw)
 Check for (and work around) a MySQL auto-increment bug.
static isNewInstall (IDatabase $dbw)
static reassignArRevIds (IDatabase $dbw, array $arIds, array $conds=[])
 Assign new ar_rev_ids to a set of ar_ids.
- 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).
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.
static shouldExecute ()

Protected Member Functions

 doDBUpdates ()
 Do the actual work.
 getUpdateKey ()
 Get the update key name to go in the update log table.
- Protected Member Functions inherited from LoggedUpdateMaintenance
 updateSkippedMessage ()
 Message to show that the update was done already and was just skipped.
- Protected Member Functions inherited from Maintenance
 addArg ( $arg, $description, $required=true)
 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.
 adjustMemoryLimit ()
 Adjusts PHP's memory limit to better suit our needs, if needed.
 afterFinalSetup ()
 Override to perform any required operation at the end of initialisation.
 beginTransaction (IDatabase $dbw, $fname)
 Begin a transaction on a DB.
 commitTransaction (IDatabase $dbw, $fname)
 Commit the transaction on a DB handle and wait for replica DBs 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.
 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.
 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.
 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).
 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.
 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 DBs to catch up.

Additional Inherited Members

- Public Attributes inherited from 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 = 'Generic maintenance parameters'
const SCRIPT_DEPENDENT_PARAMETERS = 'Script dependent parameters'
const STDIN_ALL = -1
- Protected Attributes inherited from Maintenance
array $mArgList = []
array $mArgs = []
 This is the list of arguments that were actually passed.
int null $mBatchSize = null
 Batch size.
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 = []
bool $mQuiet = false
 Special vars for params that are always used.
string null $mSelf
 Name of the script currently running.
MaintenanceParameters $parameters

Detailed Description

Maintenance script that populares archive.ar_rev_id in old rows.


Definition at line 37 of file populateArchiveRevId.php.

Constructor & Destructor Documentation

◆ __construct()

PopulateArchiveRevId::__construct ( )

Default constructor.

Children should call this first if implementing their own constructors

Stability: stable
to call

Reimplemented from LoggedUpdateMaintenance.

Definition at line 42 of file populateArchiveRevId.php.

References Maintenance\addDescription(), and Maintenance\setBatchSize().

Member Function Documentation

◆ checkMysqlAutoIncrementBug()

static PopulateArchiveRevId::checkMysqlAutoIncrementBug ( IDatabase $dbw)

Check for (and work around) a MySQL auto-increment bug.

(T202032) MySQL until 8.0 and MariaDB until some version after 10.1.34 don't save the auto-increment value to disk, so on server restart it might reuse IDs from deleted revisions. We can fix that with an insert with an explicit rev_id value, if necessary.


Definition at line 113 of file populateArchiveRevId.php.

References Wikimedia\Rdbms\IDatabase\delete(), Wikimedia\Rdbms\IDatabase\doAtomicSection(), Wikimedia\Rdbms\IDatabase\getType(), Wikimedia\Rdbms\IDatabase\insert(), Wikimedia\Rdbms\IDatabase\insertId(), and Wikimedia\Rdbms\IDatabase\selectField().

Referenced by DeduplicateArchiveRevId\doDBUpdates(), and doDBUpdates().

◆ doDBUpdates()

PopulateArchiveRevId::doDBUpdates ( )

Do the actual work.

All child classes will need to implement this. Return true to log the update as done or false (usually on failure).


Reimplemented from LoggedUpdateMaintenance.

Definition at line 61 of file populateArchiveRevId.php.

References checkMysqlAutoIncrementBug(), DB_PRIMARY, Maintenance\getBatchSize(), getDB(), Maintenance\output(), and reassignArRevIds().

◆ getUpdateKey()

PopulateArchiveRevId::getUpdateKey ( )

Get the update key name to go in the update log table.


Reimplemented from LoggedUpdateMaintenance.

Definition at line 57 of file populateArchiveRevId.php.

◆ isNewInstall()

static PopulateArchiveRevId::isNewInstall ( IDatabase $dbw)

Definition at line 52 of file populateArchiveRevId.php.

References Wikimedia\Rdbms\IDatabase\selectRowCount().

Referenced by DeduplicateArchiveRevId\doDBUpdates().

◆ reassignArRevIds()

static PopulateArchiveRevId::reassignArRevIds ( IDatabase $dbw,
array $arIds,
array $conds = [] )

Assign new ar_rev_ids to a set of ar_ids.

array$condsExtra conditions for the update
int Number of updated rows

Definition at line 158 of file populateArchiveRevId.php.

References Wikimedia\Rdbms\IDatabase\affectedRows(), Wikimedia\Rdbms\IDatabase\delete(), Wikimedia\Rdbms\IDatabase\doAtomicSection(), Wikimedia\Rdbms\IDatabase\insert(), Wikimedia\Rdbms\IDatabase\selectFieldValues(), and Wikimedia\Rdbms\IDatabase\update().

Referenced by doDBUpdates().

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