Manual:runJobs.php

From MediaWiki.org
Jump to: navigation, search

Other languages:
català • ‎Deutsch • ‎English • ‎español • ‎suomi • ‎français • ‎italiano • ‎日本語 • ‎Bahasa Melayu • ‎Nederlands • ‎polski • ‎português • ‎português do Brasil • ‎русский

Details[edit]

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 $wgJobRunRateManual:$wgJobRunRate in LocalSettings.phpManual:LocalSettings.php file.

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 would be advised to first try 50 or 100 to get a feel for the script's speed before running it with no parameters (this script defaults to 10,000 jobs cleared each time it is run) or for more than a few hundred jobs.

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.

Usage[edit]

php maintenance/runJobs.php

Advanced Usage[edit]

php runJobs.php [--conf|--dbpass|--dbuser|--globals|--help|--maxjobs|--maxtime|--memory-limit|--nothrottle|--procs|--quiet|--server|--type|--wait|--wiki]

Generic maintenance parameters[edit]

Option/Parameter Description
no parameters Will run the next 10,000 jobs in the job 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 parameters[edit]

Option/Parameter Description
--dbuser The DB user to use for this script
--dbpass The password to use for this script

Script specific parameters[edit]

Option/Parameter Description
--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

Example[edit]

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

Note Note: It is not recommended to have runJobs.php run indefinitely without any limits (--maxjobs, --maxtime and/or --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.

Caveats[edit]

"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_DB;

Then run "runJobs.php" with the --conf parameter to specify the location of the new LocalSettings.php file with caching disabled.

See also[edit]