|MediaWiki file: runJobs.php|
|Source code:||master • 1.36.2 • 1.35.4|
runJobs.php file is a maintenance script to manually force the job queue to run. Under normal circumstances jobs in the queue are run as a function of user interaction with the wiki (ordinary apache requests). The default rate jobs are run is 1 to 1 and can be changed by adjusting $wgJobRunRate in the LocalSettings.php file. Note that the default memory limit for a job is 150 MB so that a bad job does not consume all the server's memory.
You may wish to use this script because your wiki's traffic is too slow to clear the queue, or there may be an exceptionally large number of jobs to clear. Be advised though that for many server configurations this can cause your wiki to become sluggish or even unresponsive until the script completes. You are advised to first try 50 or 100 to get a feel for the script's speed before running it for several hundred jobs or with no parameters.
Note also that if you accidentally ran a script that loaded the job queue with a large number of undesired or unneeded jobs it is also possible to completely clear the job queue by clearing the job table in your wiki database. Be certain there are no jobs in the queue you need as all jobs will be irretrievably deleted.
php runJobs.php [--conf|--dbpass|--dbuser|--globals|--help|--maxjobs|--maxtime|--memory-limit|--nothrottle|--procs|--quiet|--server|--type|--wait|--wiki]
Generic maintenance parametersEdit
|no parameters||Will run all jobs currently in the queue|
|--help (-h)||Display this help message|
|--quiet (-q)||Whether to suppress non-error output|
|--conf||Location of "LocalSettings.php", if not default|
|--wiki||For specifying the wiki ID|
|--globals||Output globals at the end of processing for debugging|
|--memory-limit||Set a specific memory limit for the script, "max" for no limit or "default" to avoid changing it|
|--server||The protocol and server name to use in URLs, e.g. https://en.wikipedia.org. This is sometimes necessary because server name detection may fail in command line scripts.|
Script dependant parametersEdit
|--dbuser||The DB user to use for this script|
|--dbpass||The password to use for this script|
Script specific parametersEdit
|--maxjobs||Maximum number of jobs to run|
|--maxtime||Maximum amount of wall-clock time (in seconds)|
|--procs||Number of processes to use|
|--type||Type of job to run. See $wgJobClasses for available job types.|
|--wait||Wait for new jobs instead of exiting|
|--nothrottle||Ignore the job throttling configuration|
|--result||Set to "json" to print only a JSON response|
php maintenance/runJobs.php --maxjobs 5 --type refreshLinks
/home/flowerwiki/public_html/w/maintenance$ php runJobs.php --maxjobs 5 --type refreshLinks 2010-10-29 13:50:38 refreshLinks Daisies t=501 good 2010-10-29 13:50:38 refreshLinks Magnolias t=501 good 2010-10-29 13:50:39 refreshLinks Heirloom_Roses t=500 good 2010-10-29 13:50:39 refreshLinks Carnations t=501 good 2010-10-29 13:50:40 refreshLinks Tulips t=563 good
--memory-limit). Typical usage involves periodic runs with at least one of the restrictions set to prevent it from running too long in one go.
"runJobs.php" may hang under certain circumstances if you have object caching enabled. If this happens, create another "LocalSettings.php" file without object caching enabled:
$wgMainCacheType = CACHE_NONE;
Then run "runJobs.php" with the
--conf parameter to specify the location of the new
LocalSettings.php file with caching disabled.
This is, however, not recommended, since some jobs will purge objects from the object cache, which won't get purged because caching is disabled. This will result in some updates not being reflected on the wiki. Ideally, you should find the cause of the problem, usually a missing PHP extension in the php.ini of the php being run from the command line.