docs/maintenance.txt File Reference

Classes
class	Maintenance
	Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effort. More...

Variables
class DemoMaint extends Maintenance	$maintClass = "DemoMaint"
you have access to all of the normal MediaWiki so you can get a DB use the	cache
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
you have access to all of the normal MediaWiki so you can get a DB	connection
Prior to maintenance scripts were a hodgepodge of code that had no cohesion or formal method of action Beginning maintenance scripts have been cleaned up to use a unified class Directory structure How to run a script How to write your own DIRECTORY STRUCTURE The maintenance directory of a MediaWiki installation contains several all of which have unique purposes HOW TO RUN A SCRIPT Ridiculously just call php someScript php that s in the top level maintenance directory	Example
Prior to maintenance scripts were a hodgepodge of code that had no cohesion or formal method of action Beginning maintenance scripts have been cleaned up to use a unified class Directory structure How to run a script How to write your own DIRECTORY STRUCTURE The maintenance directory of a MediaWiki installation contains several all of which have unique purposes HOW TO RUN A SCRIPT Ridiculously just call php someScript php that s in the top level maintenance directory if not default do this many per batch HOW TO WRITE YOUR OWN Make a file in the maintenance directory called myScript php or something In write the	following
you have access to all of the normal MediaWiki	functions
Prior to maintenance scripts were a hodgepodge of code that had no cohesion or formal method of action Beginning	in
Prior to maintenance scripts were a hodgepodge of code that had no cohesion or formal method of action Beginning maintenance scripts have been cleaned up to use a unified class Directory structure How to run a script How to write your own DIRECTORY STRUCTURE The maintenance directory of a MediaWiki installation contains several all of which have unique purposes HOW TO RUN A SCRIPT Ridiculously just call php someScript php that s in the top level maintenance directory if not default do this many per batch HOW TO WRITE YOUR OWN Make a file in the maintenance directory called myScript php or something In	it
require_once	RUN_MAINTENANCE_IF_MAIN
Prior to maintenance scripts were a hodgepodge of code that had no cohesion or formal method of action Beginning maintenance scripts have been cleaned up to use a unified class Directory structure How to run a script How to write your own DIRECTORY STRUCTURE The maintenance directory of a MediaWiki installation contains several all of which have unique purposes HOW TO RUN A SCRIPT Ridiculously	simple
Prior to maintenance scripts were a hodgepodge of code that had no cohesion or formal method of action Beginning maintenance scripts have been cleaned up to use a unified class Directory structure How to run a script How to write your own DIRECTORY STRUCTURE The maintenance directory of a MediaWiki installation contains several	subdirectories
Prior to	version
Prior to maintenance scripts were a hodgepodge of code that had no cohesion or formal method of action Beginning maintenance scripts have been cleaned up to use a unified class Directory structure How to run a script How to write your own DIRECTORY STRUCTURE The maintenance directory of a MediaWiki installation contains several all of which have unique purposes HOW TO RUN A SCRIPT Ridiculously just call php someScript php that s in the top level maintenance directory if not default	wiki

Variable Documentation

$maintClass

class DemoMaint extends Maintenance $maintClass = "DemoMaint"

cache

you have access to all of the normal MediaWiki so you can get a DB use the cache

Definition at line 55 of file maintenance.txt.

Referenced by JobQueueGroup::__construct(), RepoGroup::__construct(), ProcessCacheLRU::__construct(), MediaWiki\Auth\ThrottlePreAuthenticationProvider::__construct(), GitInfo::__construct(), CryptHKDF::__construct(), PageProps::__construct(), FileContentsHasher::__construct(), MediaWiki\Auth\Throttler::__construct(), JobQueueDB::__construct(), WANObjectCache::__construct(), MediaWiki\Revision\RevisionStoreFactory::__construct(), WatchedItemStore::__construct(), MediaWiki\Storage\NameTableStoreFactory::__construct(), MediaWiki\Storage\NameTableStore::__construct(), OATHUserRepository::__construct(), MediaWiki\Revision\RevisionStore::__construct(), MediaWiki\Storage\BlobStoreFactory::__construct(), MediaWiki\Storage\SqlBlobStore::__construct(), CachingSiteStore::__construct(), WANObjectCacheReaper::__construct(), MessageCache::__construct(), CryptHKDF::__destruct(), MappedIterator::accept(), MediaWiki\Storage\NameTableStore::acquireId(), WatchedItemStore::addWatchBatchForUser(), WatchedItemStore::cache(), GitInfo::cacheIsComplete(), PageProps::cacheProperties(), PageProps::cacheProperty(), JobQueueDB::claimRandom(), MapCacheLRU::clear(), ProcessCacheLRU::clear(), MediaWiki\Auth\Throttler::clear(), MessageCache::clear(), RepoGroup::clearCache(), WANObjectCache::clearLastError(), MappedIterator::current(), JobQueueDB::doFlushCaches(), JobQueueDB::doGetAbandonedCount(), JobQueueDB::doGetAcquiredCount(), JobQueueDB::doGetSize(), WANObjectCache::doGetWithSetCallback(), GenderCache::doQuery(), UserCache::doQuery(), PageProps::ensureCacheSize(), WebInstallerOptions::execute(), MediaWiki\Storage\SqlBlobStore::expandBlob(), ArrayBackedMemoizedCallable::fetchResult(), OATHUserRepository::findByUser(), RepoGroup::findFile(), MapCacheLRU::get(), ProcessCacheLRU::get(), MapCacheLRU::getAllKeys(), MessageCache::getAllMessageKeys(), MediaWiki\Storage\SqlBlobStore::getBlob(), ProcessCacheLRUTestable::getCache(), WatchedItemStore::getCached(), PageProps::getCachedProperties(), PageProps::getCachedProperty(), MediaWiki\Storage\SqlBlobStore::getCacheKey(), JobQueueDB::getCacheKey(), CachingSiteStore::getCacheKey(), MediaWiki\Storage\NameTableStore::getCacheKey(), WatchedItemStore::getCacheKey(), MediaWiki\Storage\SqlBlobStore::getCacheTTL(), GitInfo::getCurrentBranch(), ProcessCacheLRUTestable::getEntriesCount(), MapCacheLRU::getField(), FileContentsHasher::getFileContentsHashInternal(), GenderCache::getGenderOf(), GitInfo::getHead(), GitInfo::getHeadCommitDate(), GitInfo::getHeadSHA1(), WANObjectCache::getInterimValue(), MediaWiki\Revision\RevisionStore::getKnownCurrentRevision(), WANObjectCache::getLastError(), MessageCache::getMsgFromNamespace(), WANObjectCache::getMulti(), WANObjectCache::getMultiCheckKeyTime(), MediaWiki\Storage\NameTableStore::getName(), UserCache::getProp(), WANObjectCache::getQoS(), WANObjectCache::getRawKeysForWarmup(), GitInfo::getRemoteUrl(), MediaWiki\Revision\RevisionStore::getRevisionRowCacheKey(), CryptHKDF::getSaltUsingCache(), CachingSiteStore::getSites(), ProcessCacheLRU::getSize(), MediaWiki\Storage\NameTableStore::getTableFromCachesOrReplica(), MapCacheLRU::has(), ProcessCacheLRU::has(), MediaWiki\Auth\Throttler::increase(), WANObjectCacheReaper::invoke(), MessageCache::load(), MessageCache::loadFromDB(), MessageCache::loadFromDBWithLock(), WatchedItemStore::loadWatchedItem(), WANObjectCache::makeGlobalKey(), WANObjectCache::makeKey(), mccShowUsage(), MovePage::move(), MediaWiki\Storage\BlobStoreFactory::newSqlBlobStore(), MappedIterator::next(), OATHUserRepository::persist(), MapCacheLRU::ping(), JobQueueGroup::pop(), GitInfo::precomputeValues(), WANObjectCache::processCheckKeys(), JobQueueGroup::push(), WANObjectCache::reap(), WANObjectCache::reapCheckKey(), MessageCache::refreshAndReplaceInternal(), WANObjectCache::relayDelete(), WANObjectCache::relayPurge(), MediaWiki\Storage\NameTableStore::reloadMap(), OATHUserRepository::remove(), MessageCache::replace(), CachingSiteStore::reset(), ProcessCacheLRU::resize(), MappedIterator::rewind(), MapCacheLRU::serialize(), ProcessCacheLRU::set(), MapCacheLRU::set(), WANObjectCache::set(), MediaWiki\Auth\ThrottlePreAuthenticationProvider::setConfig(), MapCacheLRU::setField(), WANObjectCache::setInterimValue(), MapCacheLRU::setMaxSize(), WANObjectCache::setMockTime(), BagOStuffTest::setUp(), MultiWriteBagOStuffTest::setUp(), ReplicatedBagOStuffTest::setUp(), WANObjectCacheTest::setUp(), MemcachedBagOStuffTest::setUp(), RedisBagOStuffTest::setUp(), ArrayBackedMemoizedCallable::storeResult(), WANObjectCacheTest::testAdaptiveTTL(), BagOStuffTest::testAdd(), BagOStuffTest::testChangeTTL(), WANObjectCacheTest::testDelete(), BagOStuffTest::testGet(), ReplicatedBagOStuffTest::testGet(), ReplicatedBagOStuffTest::testGetAbsent(), BagOStuffTest::testGetMulti(), WANObjectCacheTest::testGetMultiWithSetCallback(), WANObjectCacheTest::testGetMultiWithUnionSetCallback(), WANObjectCacheTest::testGetNotExists(), BagOStuffTest::testGetScopedLock(), BagOStuffTest::testGetWithSetCallback(), WANObjectCacheTest::testGetWithSetCallback_invalidCallback(), WANObjectCacheTest::testGetWithSeveralCheckKeys(), BagOStuffTest::testIncr(), BagOStuffTest::testIncrWithInit(), MemcachedBagOStuffTest::testKeyNormalization(), BagOStuffTest::testLocking(), BagOStuffTest::testMerge(), BagOStuffTest::testMerge_fork(), WANObjectCacheTest::testProcessCache(), WANObjectCacheTest::testReap(), RedisBagOStuffTest::testSerialize(), ReplicatedBagOStuffTest::testSet(), WANObjectCacheTest::testSetAndGet(), MultiWriteBagOStuffTest::testSetDelayed(), MultiWriteBagOStuffTest::testSetImmediate(), WANObjectCacheTest::testSetLogger(), WANObjectCacheTest::testSetOver(), WANObjectCacheTest::testSetWithLag(), WANObjectCacheTest::testStaleSet(), MultiWriteBagOStuffTest::testSyncMerge(), RedisBagOStuffTest::testUnserialize(), MemcachedBagOStuffTest::testValidateKeyEncoding(), MemcachedBagOStuffTest::testValidateKeyEncodingThrowsException(), WANObjectCacheTest::testWritePending(), WatchedItemStore::uncache(), WatchedItemStore::uncacheAllItemsForUser(), WatchedItemStore::uncacheLinkTarget(), WatchedItemStore::uncacheUser(), and MapCacheLRU::unserialize().

class

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

Definition at line 56 of file maintenance.txt.

Referenced by PPNode_Hash_Tree::factory(), ApiQueryInfo::getTokenFunctions(), ApiQueryRecentChanges::getTokenFunctions(), ApiQueryRevisions::getTokenFunctions(), and ApiQueryUsers::getTokenFunctions().

connection

you have access to all of the normal MediaWiki so you can get a DB connection

Definition at line 55 of file maintenance.txt.

Referenced by mccShowUsage().

Example

Prior to maintenance scripts were a hodgepodge of code that had no cohesion or formal method of action Beginning maintenance scripts have been cleaned up to use a unified class Directory structure How to run a script How to write your own DIRECTORY STRUCTURE The maintenance directory of a MediaWiki installation contains several all of which have unique purposes HOW TO RUN A SCRIPT Ridiculously just call php someScript php that s in the top level maintenance directory Example

Definition at line 17 of file maintenance.txt.

following

Prior to maintenance scripts were a hodgepodge of code that had no cohesion or formal method of action Beginning maintenance scripts have been cleaned up to use a unified class Directory structure How to run a script How to write your own DIRECTORY STRUCTURE The maintenance directory of a MediaWiki installation contains several all of which have unique purposes HOW TO RUN A SCRIPT Ridiculously just call php someScript php that s in the top level maintenance directory if not default do this many per batch HOW TO WRITE YOUR OWN Make a file in the maintenance directory called myScript php or something In write the following

Definition at line 31 of file maintenance.txt.

functions

you have access to all of the normal MediaWiki functions

Definition at line 55 of file maintenance.txt.

in

Prior to maintenance scripts were a hodgepodge of code that had no cohesion or formal method of action Beginning in

Definition at line 2 of file maintenance.txt.

it

Prior to maintenance scripts were a hodgepodge of code that had no cohesion or formal method of action Beginning maintenance scripts have been cleaned up to use a unified class Directory structure How to run a script How to write your own DIRECTORY STRUCTURE The maintenance directory of a MediaWiki installation contains several all of which have unique purposes HOW TO RUN A SCRIPT Ridiculously just call php someScript php that s in the top level maintenance directory if not default do this many per batch HOW TO WRITE YOUR OWN Make a file in the maintenance directory called myScript php or something In it

Definition at line 31 of file maintenance.txt.

RUN_MAINTENANCE_IF_MAIN

require_once RUN_MAINTENANCE_IF_MAIN

Definition at line 50 of file maintenance.txt.

simple

Prior to maintenance scripts were a hodgepodge of code that had no cohesion or formal method of action Beginning maintenance scripts have been cleaned up to use a unified class Directory structure How to run a script How to write your own DIRECTORY STRUCTURE The maintenance directory of a MediaWiki installation contains several all of which have unique purposes HOW TO RUN A SCRIPT Ridiculously simple

Definition at line 14 of file maintenance.txt.

subdirectories

Prior to maintenance scripts were a hodgepodge of code that had no cohesion or formal method of action Beginning maintenance scripts have been cleaned up to use a unified class Directory structure How to run a script How to write your own DIRECTORY STRUCTURE The maintenance directory of a MediaWiki installation contains several subdirectories

Definition at line 11 of file maintenance.txt.

version

it is up to the author donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License If the distribution and or use of the Program is restricted in certain countries either by patents or by copyrighted the original copyright holder who places the Program under this License may add an geographical distribution limitation excluding those so that distribution is permitted only in or among countries not thus excluded In such this License incorporates the limitation as if written in the body of this License The Free Software Foundation may publish revised and or new versions of the General Public License from time to time Such new versions will be similar in spirit to the present but may differ in detail to address new problems or concerns Each version is given a distinguishing version number If the Program specifies a version number of this License which applies to it and any later version

Definition at line 1 of file maintenance.txt.

Referenced by DeprecatedGlobal::__construct(), CleanupInvalidDbKeys::__construct(), ResourceLoaderContext::__construct(), DeprecatedGlobal::_newObject(), PHPVersionCheck::checkRequiredPHPVersion(), DjVuImage::convertDumpToXML(), ImportTest::getRedirectXML(), ImportTest::getSiteInfoXML(), ImportTest::getUnknownTagsXML(), DerivativeResourceLoaderContext::getVersion(), DerivativeResourceLoaderContext::setVersion(), XmlTypeCheckTest::testRecursiveEntity(), and ImportTest::testUnknownUserHandling().

wiki

Prior to maintenance scripts were a hodgepodge of code that had no cohesion or formal method of action Beginning maintenance scripts have been cleaned up to use a unified class Directory structure How to run a script How to write your own DIRECTORY STRUCTURE The maintenance directory of a MediaWiki installation contains several all of which have unique purposes HOW TO RUN A SCRIPT Ridiculously just call php someScript php that s in the top level maintenance directory if not default wiki

Definition at line 26 of file maintenance.txt.

Referenced by showUsage().