MediaWiki  REL1_31
JobQueueDB Class Reference

Class to handle job queues stored in the DB. More...

Inheritance diagram for JobQueueDB:
Collaboration diagram for JobQueueDB:

Public Member Functions

 doBatchPushInternal (IDatabase $dbw, array $jobs, $flags, $method)
 This function should not be called outside of JobQueueDB. More...
 
 getAllAcquiredJobs ()
 
 getAllQueuedJobs ()
 
 getCoalesceLocationInternal ()
 Do not use this function outside of JobQueue/JobQueueGroup. More...
 
 recycleAndDeleteStaleJobs ()
 Recycle or destroy any jobs that have been claimed for too long. More...
 
- Public Member Functions inherited from JobQueue
 ack (Job $job)
 Acknowledge that a job was completed. More...
 
 batchPush (array $jobs, $flags=0)
 Push a batch of jobs into the queue. More...
 
 deduplicateRootJob (IJobSpecification $job)
 Register the "root job" of a given job into the queue for de-duplication. More...
 
 delayedJobsEnabled ()
 
 delete ()
 Deleted all unclaimed and delayed jobs from the queue. More...
 
 flushCaches ()
 Clear any process and persistent caches. More...
 
 getAbandonedCount ()
 Get the number of acquired jobs that can no longer be attempted. More...
 
 getAcquiredCount ()
 Get the number of acquired jobs (these are temporarily out of the queue). More...
 
 getAllAbandonedJobs ()
 Get an iterator to traverse over all abandoned jobs in this queue. More...
 
 getAllDelayedJobs ()
 Get an iterator to traverse over all delayed jobs in this queue. More...
 
 getDelayedCount ()
 Get the number of delayed jobs (these are temporarily out of the queue). More...
 
 getOrder ()
 
 getReadOnlyReason ()
 
 getSiblingQueueSizes (array $types)
 Check the size of each of the given queues. More...
 
 getSiblingQueuesWithJobs (array $types)
 Check whether each of the given queues are empty. More...
 
 getSize ()
 Get the number of available (unacquired, non-delayed) jobs in the queue. More...
 
 getType ()
 
 getWiki ()
 
 isEmpty ()
 Quickly check if the queue has no available (unacquired, non-delayed) jobs. More...
 
 pop ()
 Pop a job off of the queue. More...
 
 push ( $jobs, $flags=0)
 Push one or more jobs into the queue. More...
 
 waitForBackups ()
 Wait for any replica DBs or backup servers to catch up. More...
 

Static Public Member Functions

static selectFields ()
 Return the list of job fields that should be selected. More...
 
- Static Public Member Functions inherited from JobQueue
static factory (array $params)
 Get a job queue object of the specified type. More...
 
static incrStats ( $key, $type, $delta=1)
 Call wfIncrStats() for the queue overall and for the queue type. More...
 

Public Attributes

const CACHE_TTL_SHORT = 30
 
const MAX_AGE_PRUNE = 604800
 
const MAX_JOB_RANDOM = 2147483647
 
const MAX_OFFSET = 255
 
- Public Attributes inherited from JobQueue
const QOS_ATOMIC = 1
 
const ROOTJOB_TTL = 2419200
 

Protected Member Functions

 __construct (array $params)
 Additional parameters include: More...
 
 claimOldest ( $uuid)
 Reserve a row with a single UPDATE without holding row locks over RTTs... More...
 
 claimRandom ( $uuid, $rand, $gte)
 Reserve a row with a single UPDATE without holding row locks over RTTs... More...
 
 doAck (Job $job)
 
 doBatchPush (array $jobs, $flags)
 
 doDeduplicateRootJob (IJobSpecification $job)
 
 doDelete ()
 
 doFlushCaches ()
 
 doGetAbandonedCount ()
 
 doGetAcquiredCount ()
 
 doGetSiblingQueueSizes (array $types)
 
 doGetSiblingQueuesWithJobs (array $types)
 
 doGetSize ()
 
 doIsEmpty ()
 
 doPop ()
 
 doWaitForBackups ()
 
 getDB ( $index)
 
 getJobIterator (array $conds)
 
 getMasterDB ()
 
 getReplicaDB ()
 
 insertFields (IJobSpecification $job)
 
 optimalOrder ()
 Get the default queue order to use if configuration does not specify one. More...
 
 supportedOrders ()
 Get the allowed queue orders for configuration validation. More...
 
 throwDBException (DBError $e)
 
- Protected Member Functions inherited from JobQueue
 assertNotReadOnly ()
 
 doGetDelayedCount ()
 
 doIsRootJobOldDuplicate (Job $job)
 
 getRootJobCacheKey ( $signature)
 
 isRootJobOldDuplicate (Job $job)
 Check if the "root" job of a given job has been superseded by a newer one. More...
 
 supportsDelayedJobs ()
 Find out if delayed jobs are supported for configuration validation. More...
 

Static Protected Member Functions

static extractBlob ( $blob)
 
static makeBlob ( $params)
 

Protected Attributes

WANObjectCache $cache
 
bool string $cluster = false
 Name of an external DB cluster. More...
 
- Protected Attributes inherited from JobQueue
JobQueueAggregator $aggr
 
int $claimTTL
 Time to live in seconds. More...
 
BagOStuff $dupCache
 
int $maxTries
 Maximum number of times to try a job. More...
 
string $order
 Job priority for pop() More...
 
string bool $readOnlyReason
 Read only rationale (or false if r/w) More...
 
string $type
 Job type. More...
 
string $wiki
 Wiki ID. More...
 

Private Member Functions

 getCacheKey ( $property)
 

Detailed Description

Class to handle job queues stored in the DB.

Since
1.21

Definition at line 35 of file JobQueueDB.php.

Constructor & Destructor Documentation

◆ __construct()

JobQueueDB::__construct ( array  $params)
protected

Additional parameters include:

  • cluster : The name of an external cluster registered via LBFactory. If not specified, the primary DB cluster for the wiki will be used. This can be overridden with a custom cluster so that DB handles will be retrieved via LBFactory::getExternalLB() and getConnection().
    Parameters
    array$params

Reimplemented from JobQueue.

Definition at line 55 of file JobQueueDB.php.

References $params, cache, and ObjectCache\getMainWANInstance().

Member Function Documentation

◆ claimOldest()

JobQueueDB::claimOldest (   $uuid)
protected

Reserve a row with a single UPDATE without holding row locks over RTTs...

Parameters
string$uuid32 char hex string
Returns
stdClass|bool Row|false

Definition at line 406 of file JobQueueDB.php.

References getMasterDB(), type, and wfDebug().

Referenced by doPop().

◆ claimRandom()

JobQueueDB::claimRandom (   $uuid,
  $rand,
  $gte 
)
protected

Reserve a row with a single UPDATE without holding row locks over RTTs...

Parameters
string$uuid32 char hex string
int$randRandom unsigned integer (31 bits)
bool$gteSearch for job_random >= $random (otherwise job_random <= $random)
Returns
stdClass|bool Row|false

Definition at line 329 of file JobQueueDB.php.

References cache, getCacheKey(), getMasterDB(), and type.

Referenced by doPop().

◆ doAck()

JobQueueDB::doAck ( Job  $job)
protected
See also
JobQueue::doAck()
Parameters
Job$job
Exceptions
MWException

Reimplemented from JobQueue.

Definition at line 466 of file JobQueueDB.php.

References $e, $job, DBO_TRX, getMasterDB(), JobQueue\incrStats(), throwDBException(), type, and use.

◆ doBatchPush()

JobQueueDB::doBatchPush ( array  $jobs,
  $flags 
)
protected
See also
JobQueue::doBatchPush()
Parameters
IJobSpecification[]$jobs
int$flags
Exceptions
DBError|Exception
Returns
void

Reimplemented from JobQueue.

Definition at line 186 of file JobQueueDB.php.

References $fname, doBatchPushInternal(), getMasterDB(), and use.

◆ doBatchPushInternal()

JobQueueDB::doBatchPushInternal ( IDatabase  $dbw,
array  $jobs,
  $flags,
  $method 
)

This function should not be called outside of JobQueueDB.

Parameters
IDatabase$dbw
IJobSpecification[]$jobs
int$flags
string$method
Exceptions
DBError
Returns
void

Definition at line 216 of file JobQueueDB.php.

References $e, $job, $res, $rows, as, Wikimedia\Rdbms\IDatabase\endAtomic(), JobQueue\incrStats(), Wikimedia\Rdbms\IDatabase\insert(), insertFields(), Wikimedia\Rdbms\IDatabase\select(), Wikimedia\Rdbms\IDatabase\startAtomic(), throwDBException(), type, and wfDebug().

Referenced by doBatchPush().

◆ doDeduplicateRootJob()

JobQueueDB::doDeduplicateRootJob ( IJobSpecification  $job)
protected

◆ doDelete()

JobQueueDB::doDelete ( )
protected
See also
JobQueue::doDelete()
Returns
bool

Reimplemented from JobQueue.

Definition at line 530 of file JobQueueDB.php.

References $e, getMasterDB(), throwDBException(), and type.

◆ doFlushCaches()

JobQueueDB::doFlushCaches ( )
protected
Returns
void

Reimplemented from JobQueue.

Definition at line 553 of file JobQueueDB.php.

References JobQueue\$type, as, cache, and getCacheKey().

◆ doGetAbandonedCount()

JobQueueDB::doGetAbandonedCount ( )
protected
See also
JobQueue::doGetAbandonedCount()
Returns
int
Exceptions
MWException

Reimplemented from JobQueue.

Definition at line 148 of file JobQueueDB.php.

References $dbr, $e, cache, getCacheKey(), getReplicaDB(), and throwDBException().

◆ doGetAcquiredCount()

JobQueueDB::doGetAcquiredCount ( )
protected
See also
JobQueue::doGetAcquiredCount()
Returns
int

Reimplemented from JobQueue.

Definition at line 117 of file JobQueueDB.php.

References $dbr, $e, cache, getCacheKey(), getReplicaDB(), and throwDBException().

◆ doGetSiblingQueueSizes()

JobQueueDB::doGetSiblingQueueSizes ( array  $types)
protected
See also
JobQueue::getSiblingQueuesSize()
Parameters
array$typesList of queues types
Returns
array|null (list of queue types) or null if unsupported

Reimplemented from JobQueue.

Definition at line 624 of file JobQueueDB.php.

References $dbr, $res, as, and getReplicaDB().

◆ doGetSiblingQueuesWithJobs()

JobQueueDB::doGetSiblingQueuesWithJobs ( array  $types)
protected
See also
JobQueue::getSiblingQueuesWithJobs()
Parameters
array$typesList of queues types
Returns
array|null (list of queue types) or null if unsupported

Reimplemented from JobQueue.

Definition at line 607 of file JobQueueDB.php.

References $dbr, $res, as, and getReplicaDB().

◆ doGetSize()

JobQueueDB::doGetSize ( )
protected
See also
JobQueue::doGetSize()
Returns
int

Reimplemented from JobQueue.

Definition at line 91 of file JobQueueDB.php.

References $dbr, $e, cache, getCacheKey(), getReplicaDB(), and throwDBException().

◆ doIsEmpty()

JobQueueDB::doIsEmpty ( )
protected
See also
JobQueue::doIsEmpty()
Returns
bool

Reimplemented from JobQueue.

Definition at line 74 of file JobQueueDB.php.

References $dbr, $e, getReplicaDB(), throwDBException(), and type.

◆ doPop()

JobQueueDB::doPop ( )
protected

◆ doWaitForBackups()

JobQueueDB::doWaitForBackups ( )
protected
See also
JobQueue::doWaitForBackups()
Returns
void

Reimplemented from JobQueue.

Definition at line 545 of file JobQueueDB.php.

References wiki.

◆ extractBlob()

static JobQueueDB::extractBlob (   $blob)
staticprotected
Parameters
string$blob
Returns
bool|mixed

Definition at line 815 of file JobQueueDB.php.

References $blob, and unserialize().

◆ getAllAcquiredJobs()

JobQueueDB::getAllAcquiredJobs ( )
See also
JobQueue::getAllAcquiredJobs()
Returns
Iterator

Reimplemented from JobQueue.

Definition at line 571 of file JobQueueDB.php.

References getJobIterator(), and JobQueue\getType().

◆ getAllQueuedJobs()

JobQueueDB::getAllQueuedJobs ( )
See also
JobQueue::getAllQueuedJobs()
Returns
Iterator

Reimplemented from JobQueue.

Definition at line 563 of file JobQueueDB.php.

References getJobIterator(), and JobQueue\getType().

◆ getCacheKey()

JobQueueDB::getCacheKey (   $property)
private
Parameters
string$property
Returns
string

Definition at line 792 of file JobQueueDB.php.

References $cluster, $property, list, type, wfForeignMemcKey(), wfSplitWikiID(), and wiki.

Referenced by claimRandom(), doFlushCaches(), doGetAbandonedCount(), doGetAcquiredCount(), and doGetSize().

◆ getCoalesceLocationInternal()

JobQueueDB::getCoalesceLocationInternal ( )

Do not use this function outside of JobQueue/JobQueueGroup.

Returns
string
Since
1.22

Reimplemented from JobQueue.

Definition at line 601 of file JobQueueDB.php.

◆ getDB()

JobQueueDB::getDB (   $index)
protected
Parameters
int$index(DB_REPLICA/DB_MASTER)
Returns
DBConnRef

Reimplemented in JobQueueDBSingle.

Definition at line 774 of file JobQueueDB.php.

References false, and wiki.

Referenced by getMasterDB(), and getReplicaDB().

◆ getJobIterator()

JobQueueDB::getJobIterator ( array  $conds)
protected
Parameters
array$condsQuery conditions
Returns
Iterator

Definition at line 579 of file JobQueueDB.php.

References $dbr, $e, $job, Job\factory(), function, getReplicaDB(), Title\makeTitle(), throwDBException(), and unserialize().

Referenced by getAllAcquiredJobs(), and getAllQueuedJobs().

◆ getMasterDB()

JobQueueDB::getMasterDB ( )
protected

◆ getReplicaDB()

JobQueueDB::getReplicaDB ( )
protected

◆ insertFields()

JobQueueDB::insertFields ( IJobSpecification  $job)
protected
Parameters
IJobSpecification$job
Returns
array

Definition at line 727 of file JobQueueDB.php.

References $job, getMasterDB(), IJobSpecification\getType(), makeBlob(), and serialize().

Referenced by doBatchPushInternal().

◆ makeBlob()

static JobQueueDB::makeBlob (   $params)
staticprotected
Parameters
array | bool$params
Returns
string

Definition at line 803 of file JobQueueDB.php.

References $params, and serialize().

Referenced by insertFields().

◆ optimalOrder()

JobQueueDB::optimalOrder ( )
protected

Get the default queue order to use if configuration does not specify one.

Returns
string One of (random, timestamp, fifo, undefined)

Reimplemented from JobQueue.

Definition at line 66 of file JobQueueDB.php.

◆ recycleAndDeleteStaleJobs()

JobQueueDB::recycleAndDeleteStaleJobs ( )

Recycle or destroy any jobs that have been claimed for too long.

Returns
int Number of jobs recycled/deleted

Definition at line 642 of file JobQueueDB.php.

References $e, $res, JobQueue\$type, getMasterDB(), JobQueue\incrStats(), throwDBException(), type, and wiki.

Referenced by doPop().

◆ selectFields()

static JobQueueDB::selectFields ( )
static

Return the list of job fields that should be selected.

Since
1.23
Returns
array

Definition at line 836 of file JobQueueDB.php.

◆ supportedOrders()

JobQueueDB::supportedOrders ( )
protected

Get the allowed queue orders for configuration validation.

Returns
array Subset of (random, timestamp, fifo, undefined)

Reimplemented from JobQueue.

Definition at line 62 of file JobQueueDB.php.

◆ throwDBException()

JobQueueDB::throwDBException ( DBError  $e)
protected

Member Data Documentation

◆ $cache

WANObjectCache JobQueueDB::$cache
protected

Definition at line 42 of file JobQueueDB.php.

Referenced by doDeduplicateRootJob().

◆ $cluster

bool string JobQueueDB::$cluster = false
protected

Name of an external DB cluster.

False if not set

Definition at line 45 of file JobQueueDB.php.

Referenced by getCacheKey().

◆ CACHE_TTL_SHORT

const JobQueueDB::CACHE_TTL_SHORT = 30

Definition at line 36 of file JobQueueDB.php.

◆ MAX_AGE_PRUNE

const JobQueueDB::MAX_AGE_PRUNE = 604800

Definition at line 37 of file JobQueueDB.php.

◆ MAX_JOB_RANDOM

const JobQueueDB::MAX_JOB_RANDOM = 2147483647

Definition at line 38 of file JobQueueDB.php.

◆ MAX_OFFSET

const JobQueueDB::MAX_OFFSET = 255

Definition at line 39 of file JobQueueDB.php.


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