Generic class to cleanup a database table. More...
Public Member Functions | |
| __construct () | |
| Default constructor. More... | |
| execute () | |
| Do the actual work. More... | |
| runTable ( $params) | |
 Public Member Functions inherited from Maintenance | |
| cleanupChanneled () | |
| Clean up channeled output. More... | |
| clearParamsAndArgs () | |
| Clear all params and arguments. More... | |
| finalSetup () | |
| Handle some last-minute setup here. More... | |
| 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... | |
| 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... | |
| setDB (&$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... | |
Public Attributes | |
| $batchSize = 100 | |
| $count | |
| $reportInterval = 100 | |
| $startTime | |
| $table | |
| $updated | |
| Public Attributes inherited from Maintenance | |
| resource | $fileHandle |
| Used when creating separate schema files. More... | |
| $mDbPass | |
| const | DB_ADMIN = 2 |
| const | DB_NONE = 0 |
| Constants for DB access type. More... | |
| const | DB_STD = 1 |
| const | STDIN_ALL = 'all' |
Protected Member Functions | |
| hexChar ( $matches) | |
| init ( $count, $table) | |
| progress ( $updated) | |
| Protected Member Functions inherited from Maintenance | |
| 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) | |
| 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... | |
| deleteOption ( $name) | |
| Remove an option. More... | |
| error ( $err, $die=0) | |
| Throw an error to the user. More... | |
| getArg ( $argId=0, $default=null) | |
| Get an argument. More... | |
| & | getDB ( $db, $groups=array(), $wiki=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 param 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... | |
| setBatchSize ( $s=0) | |
| Set the batch size. More... | |
| validateParamsAndArgs () | |
| Run some validation checks on the params, etc. More... | |
Protected Attributes | |
| $defaultParams | |
| $dryrun = false | |
| $maxLag = 10 | |
| $processed | |
| Protected Attributes inherited from Maintenance | |
| $mArgList = array() | |
| $mArgs = array() | |
| int | $mBatchSize = null |
| Batch size. More... | |
| $mDbUser | |
| $mDescription = '' | |
| $mInputLoaded = false | |
| $mOptions = array() | |
| $mParams = array() | |
| $mQuiet = false | |
| $mSelf | |
| $mShortParamsMap = array() | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Maintenance | |
| 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 | 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... | |
Detailed Description
Generic class to cleanup a database table.
Already subclasses Maintenance.
Definition at line 31 of file cleanupTable.inc.
Constructor & Destructor Documentation
◆ __construct()
| TableCleanup::__construct | ( | ) |
Default constructor.
Children should call this first if implementing their own constructors
Reimplemented from Maintenance.
Reimplemented in ImageCleanup, WatchlistCleanup, CapsCleanup, and TitleCleanup.
Definition at line 46 of file cleanupTable.inc.
References Maintenance\addOption().
Member Function Documentation
◆ execute()
| TableCleanup::execute | ( | ) |
Do the actual work.
All child classes will need to implement this
Reimplemented from Maintenance.
Reimplemented in WatchlistCleanup, and CapsCleanup.
Definition at line 51 of file cleanupTable.inc.
References $wgUser, global, Maintenance\hasOption(), User\newFromName(), Maintenance\output(), and runTable().
◆ hexChar()
|
protected |
- Parameters
-
array $matches
- Returns
- string
Definition at line 171 of file cleanupTable.inc.
References $matches.
◆ init()
|
protected |
Definition at line 63 of file cleanupTable.inc.
References $count, $table, and table.
Referenced by runTable().
◆ progress()
|
protected |
- Parameters
-
int $updated
Definition at line 74 of file cleanupTable.inc.
References $count, $processed, $startTime, $updated, Maintenance\output(), table, TS_DB, wfTimestamp(), and wfWikiID().
Referenced by TitleCleanup\processRow(), ImageCleanup\processRow(), WatchlistCleanup\processRow(), CapsCleanup\processRow(), and TableCleanupTest\processRow().
◆ runTable()
| TableCleanup::runTable | ( | $params | ) |
- Parameters
-
array $params
- Exceptions
-
MWException
Definition at line 108 of file cleanupTable.inc.
References $batchSize, $count, $dbr, $options, $params, $res, $table, array(), as, DB_SLAVE, init(), Maintenance\output(), and wfGetDB().
Referenced by CapsCleanup\execute(), and execute().
Member Data Documentation
◆ $batchSize
| TableCleanup::$batchSize = 100 |
Definition at line 41 of file cleanupTable.inc.
Referenced by runTable().
◆ $count
| TableCleanup::$count |
Definition at line 44 of file cleanupTable.inc.
Referenced by init(), progress(), and runTable().
◆ $defaultParams
|
protected |
Definition at line 32 of file cleanupTable.inc.
◆ $dryrun
|
protected |
Definition at line 39 of file cleanupTable.inc.
◆ $maxLag
|
protected |
Definition at line 40 of file cleanupTable.inc.
◆ $processed
|
protected |
Definition at line 44 of file cleanupTable.inc.
Referenced by progress().
◆ $reportInterval
| TableCleanup::$reportInterval = 100 |
Definition at line 42 of file cleanupTable.inc.
◆ $startTime
| TableCleanup::$startTime |
Definition at line 44 of file cleanupTable.inc.
Referenced by progress().
◆ $table
| TableCleanup::$table |
Definition at line 44 of file cleanupTable.inc.
Referenced by init(), and runTable().
◆ $updated
| TableCleanup::$updated |
Definition at line 44 of file cleanupTable.inc.
Referenced by WatchlistCleanup\processRow(), and progress().
The documentation for this class was generated from the following file:
- maintenance/cleanupTable.inc
