DatabaseQueue
class DatabaseQueue extends Queue implements Queue, ClearableQueue
Traits
Constants
| DEFAULT_RETRY_AFTER |
|
Properties
| protected Container | $container | The IoC container instance. |
from Queue |
| protected string | $connectionName | The connection name for the queue. |
from Queue |
| protected array | $config | The original configuration for the queue. |
from Queue |
| protected bool | $dispatchAfterCommit | Indicates that jobs should be dispatched after the open parent database transactions have committed. |
from Queue |
| protected null|Queue): mixed): mixed | $afterCommitDispatcher | Dispatch an after-commit operation through its live queue owner. |
from Queue |
| static protected callable[] | $createPayloadCallbacks | The create payload callbacks. |
from Queue |
Methods
Get the number of seconds until the given DateTime.
Get the "available at" UNIX timestamp.
If the given value is an interval, convert it to a DateTime instance.
Given a start time, format the total run time for human readability.
Get a configuration value from an attribute, falling back to a property.
Extract the value from an attribute instance.
Get an instance of the given attribute class from the target class or its parents.
Determine if a property declared on a child class overrides an inherited attribute.
Resolve the default connection name for a given queueable instance.
Resolve the default queue name for a given queueable instance.
Get the container that owns the queue routes.
Push a new job onto the queue.
Push a new job onto a specific queue after (n) seconds.
Push an array of jobs onto the queue.
Create a payload string from the given job and data.
Create a payload array from the given job and data.
Create a payload for an object-based queue handler.
Get the maximum number of attempts for an object-based queue handler.
Get the expiration timestamp for an object-based queue handler.
Create a typical, string based queue payload array.
Register a callback to be executed when creating job payloads.
Create the given payload using any registered payload hooks.
Set the dispatcher for after-commit queue operations.
Enqueue a job using the given callback.
Defer an enqueue operation until the applicable transaction commits.
Defer a batch enqueue operation until the applicable transaction commits.
Enqueue a job immediately using the given callback.
Finalize an encoded payload immediately before queueing.
Partition jobs by whether they should be deferred until the active transaction commits.
Determine if the job should be dispatched after the open parent database transactions have committed.
Register a transaction rollback callback that releases the job's locks.
Create a callback that releases the job's locks.
Mark a job's dispatch locks as accepted by the queue.
Raise the job queueing event.
Raise the job queueing failed event.
Raise the job queued event.
Normalize an enum queue name without applying defaults or forwarding.
Determine if the given exception was caused by a concurrency error such as a deadlock or serialization failure.
Determine if the given exception was caused by a lost connection.
Insert database rows without exceeding the connection's binding limit.
Insert one database row chunk.
Create a new database queue instance.
Get the size of the queue.
Get the number of pending jobs.
Get the number of delayed jobs.
Get the number of reserved jobs.
Get the number of jobs across every queue.
Get the number of pending jobs across every queue.
Get the number of delayed jobs across every queue.
Get the number of reserved jobs across every queue.
Get the pending jobs for the given queue.
Get the delayed jobs for the given queue.
Get the reserved jobs for the given queue.
Get all pending jobs across every queue.
Get all delayed jobs across every queue.
Get all reserved jobs across every queue.
Get the creation timestamp of the oldest pending job, excluding delayed jobs.
Push a new job onto the queue.
Push a raw payload onto the queue.
Push a new job onto the queue after (n) seconds.
Prepare the payload and delay for each of the given jobs.
Insert a prepared batch and raise its queue lifecycle events.
Release a reserved job back onto the queue after (n) seconds.
Push a raw payload to the database with a given delay of (n) seconds.
Create an array to insert for the given job.
Get the next available job for the queue.
Get the lock required for popping the next job.
Modify the query to check for jobs that are reserved but have expired.
Marshal the reserved job into a DatabaseJob instance.
Determine whether the exception matches this job's reservation update.
Delete a reserved job from the queue.
Delete a reserved job from the reserved queue and release it.
Delete all of the jobs from the queue.
Get the queue or return the default.
Get the underlying database connection.
Details
in
InteractsWithTime at line 17
protected int
secondsUntil(DateInterval|DateTimeInterface|int $delay)
Get the number of seconds until the given DateTime.
in
InteractsWithTime at line 29
protected int
availableAt(DateInterval|DateTimeInterface|int|null $delay = 0)
Get the "available at" UNIX timestamp.
in
InteractsWithTime at line 47
protected DateTimeInterface|int
parseDateInterval(DateInterval|DateTimeInterface|int|null $delay)
If the given value is an interval, convert it to a DateTime instance.
in
InteractsWithTime at line 63
protected int
currentTime()
Get the current system time as a UNIX timestamp.
in
InteractsWithTime at line 71
protected string
runTimeForHumans(float $startTime, float|null $endTime = null)
Given a start time, format the total run time for human readability.
in
ReadsClassAttributes at line 17
protected mixed
getAttributeValue(object $target, string $attributeClass, string|null $property = null, mixed $default = null)
Get a configuration value from an attribute, falling back to a property.
in
ReadsClassAttributes at line 46
protected mixed
extractAttributeValue(object $instance)
Extract the value from an attribute instance.
in
ReadsClassAttributes at line 58
protected object|null
getAttributeInstance(object $target, string $attributeClass, ReflectionClass|null $declaringClass = null)
Get an instance of the given attribute class from the target class or its parents.
in
ReadsClassAttributes at line 74
protected bool
propertyOverridesAttribute(object $target, ReflectionClass $reflection, string|null $property, ReflectionClass $attributeDeclaringClass)
Determine if a property declared on a child class overrides an inherited attribute.
in
ResolvesQueueRoutes at line 19
string|null
resolveConnectionFromQueueRoute(object $queueable, UnitEnum|string|null $queue = null)
Resolve the default connection name for a given queueable instance.
in
ResolvesQueueRoutes at line 27
string|null
resolveQueueFromQueueRoute(object $queueable)
Resolve the default queue name for a given queueable instance.
in
ResolvesQueueRoutes at line 35
protected QueueRoutes
queueRoutes()
Get the queue routes manager instance.
in
ResolvesQueueRoutes at line 48
protected Container
queueRoutesContainer()
Get the container that owns the queue routes.
in
Queue at line 89
mixed
pushOn(UnitEnum|string|null $queue, object|string $job, mixed $data = '')
Push a new job onto the queue.
in
Queue at line 97
mixed
laterOn(UnitEnum|string|null $queue, DateInterval|DateTimeInterface|int $delay, object|string $job, mixed $data = '')
Push a new job onto a specific queue after (n) seconds.
at line 326
mixed
bulk(array $jobs, mixed $data = '', UnitEnum|string|null $queue = null)
Push an array of jobs onto the queue.
Immediate and after-commit jobs use one bulk insert per attempted group. Deferred groups reacquire the queue through the after-commit dispatcher, and the return value remains null when every job is deferred.
in
Queue at line 125
protected mixed
getJobDelay(object|string $job)
Get the delay configured on the given job.
in
Queue at line 139
protected string
createPayload(array|object|string $job, string|null $queue, mixed $data = '', DateInterval|DateTimeInterface|int|null $delay = null)
Create a payload string from the given job and data.
in
Queue at line 172
protected array
createPayloadArray(array|object|string $job, string|null $queue, mixed $data = '')
Create a payload array from the given job and data.
in
Queue at line 184
protected array
createObjectPayload(object $job, string|null $queue)
Create a payload for an object-based queue handler.
in
Queue at line 252
protected string
getDisplayName(object $job)
Get the display name for the given job.
in
Queue at line 262
mixed
getJobTries(mixed $job)
Get the maximum number of attempts for an object-based queue handler.
in
Queue at line 276
mixed
getJobBackoff(mixed $job)
Get the backoff for an object-based queue handler.
in
Queue at line 296
mixed
getJobExpiration(mixed $job)
Get the expiration timestamp for an object-based queue handler.
in
Queue at line 312
protected bool
jobShouldBeEncrypted(object $job)
Determine if the job should be encrypted.
in
Queue at line 324
protected array
createStringPayload(array|string $job, string|null $queue, mixed $data)
Create a typical, string based queue payload array.
in
Queue at line 347
static void
createPayloadUsing(callable|null $callback)
Register a callback to be executed when creating job payloads.
Boot-only. The callback persists in a static property for the worker lifetime and runs on every subsequent payload creation across all coroutines. Passing null clears the registry.
in
Queue at line 359
protected array
withCreatePayloadHooks(string|null $queue, array $payload)
Create the given payload using any registered payload hooks.
in
Queue at line 375
Queue
setAfterCommitDispatcher(Closure|null $dispatcher)
Set the dispatcher for after-commit queue operations.
in
Queue at line 390
protected mixed
enqueueUsing(object|string $job, string $payload, string|null $queue, DateInterval|DateTimeInterface|int|null $delay, callable $callback)
Enqueue a job using the given callback.
The callback receives the queue that owns the operation first so deferred pooled dispatch never retains a borrowed queue.
in
Queue at line 417
protected void
deferEnqueueAfterCommit(DatabaseTransactionsManager $transactions, object|string $job, Closure $enqueue)
Defer an enqueue operation until the applicable transaction commits.
in
Queue at line 431
protected void
deferBatchEnqueueAfterCommit(DatabaseTransactionsManager $transactions, array $jobs, Closure $enqueue)
Defer a batch enqueue operation until the applicable transaction commits.
in
Queue at line 480
protected mixed
enqueueNow(object|string $job, string $payload, string|null $queue, DateInterval|DateTimeInterface|int|null $delay, callable $callback)
Enqueue a job immediately using the given callback.
in
Queue at line 505
protected string
finalizePayloadForQueueing(string|null $queue, object|string $job, string $payload, DateInterval|DateTimeInterface|int|null $delay)
Finalize an encoded payload immediately before queueing.
in
Queue at line 540
protected array
partitionJobsByAfterCommit(array $jobs, DatabaseTransactionsManager|null $transactions)
Partition jobs by whether they should be deferred until the active transaction commits.
in
Queue at line 559
protected bool
shouldDispatchAfterCommit(object|string $job)
Determine if the job should be dispatched after the open parent database transactions have committed.
in
Queue at line 575
protected void
addJobRollbackCallback(DatabaseTransactionsManager $transactions, object|string $job)
Register a transaction rollback callback that releases the job's locks.
in
Queue at line 587
protected Closure|null
createJobRollbackCallback(object|string $job)
Create a callback that releases the job's locks.
in
Queue at line 603
protected void
acceptDispatchLocks(object|string $job)
Mark a job's dispatch locks as accepted by the queue.
in
Queue at line 615
protected void
raiseJobQueueingEvent(string|null $queue, object|string $job, string $payload, DateInterval|DateTimeInterface|int|null $delay)
Raise the job queueing event.
in
Queue at line 636
protected void
raiseJobQueueingFailedEvent(string|null $queue, object|string $job, string $payload, DateInterval|DateTimeInterface|int|null $delay, Throwable $exception)
Raise the job queueing failed event.
in
Queue at line 657
protected void
raiseJobQueuedEvent(string|null $queue, mixed $jobId, object|string $job, string $payload, DateInterval|DateTimeInterface|int|null $delay)
Raise the job queued event.
in
Queue at line 676
protected string|null
normalizeQueue(UnitEnum|string|null $queue)
Normalize an enum queue name without applying defaults or forwarding.
in
Queue at line 684
protected string
resolveQueue(string $queue)
Get the routed queue name for the given queue.
in
Queue at line 700
string
getConnectionName()
Get the connection name for the queue.
in
Queue at line 712
Queue
setConnectionName(string $name)
Set the connection name for the queue.
Boot or tests only. Queue connection instances are cached on QueueManager; runtime use races across coroutines and changes every concurrent dispatch through this connection.
in
Queue at line 722
array
getConfig()
Get the queue configuration array.
in
Queue at line 734
Queue
setConfig(array $config)
Set the queue configuration array.
Boot or tests only. Queue connection instances are cached on QueueManager; runtime use races across coroutines and changes every concurrent dispatch through this connection.
in
Queue at line 744
Container
getContainer()
Get the container instance being used by the connection.
in
Queue at line 756
Queue
setContainer(Container $container)
Set the IoC container instance.
Boot or tests only. Queue connection instances are cached on QueueManager; runtime use races across coroutines and changes every concurrent dispatch through this connection.
in
Queue at line 766
static void
flushState()
Flush all static state.
in
DetectsConcurrencyErrors at line 16
protected bool
causedByConcurrencyError(Throwable $e)
Determine if the given exception was caused by a concurrency error such as a deadlock or serialization failure.
in
DetectsLostConnections at line 16
protected bool
causedByLostConnection(Throwable $e)
Determine if the given exception was caused by a lost connection.
in
InsertsDatabaseRows at line 17
protected void
insertDatabaseRows(ConnectionInterface $connection, string $table, array $rows, int $maxBindings)
Insert database rows without exceeding the connection's binding limit.
in
InsertsDatabaseRows at line 43
protected void
insertDatabaseRowChunk(ConnectionInterface $connection, string $table, array $rows)
Insert one database row chunk.
at line 47
__construct(ConnectionResolverInterface $resolver, string|null $connection, string $table, string $default = 'default', int $retryAfter = self::DEFAULT_RETRY_AFTER, bool $dispatchAfterCommit = false)
Create a new database queue instance.
at line 60
int
size(UnitEnum|string|null $queue = null)
Get the size of the queue.
at line 70
int
pendingSize(UnitEnum|string|null $queue = null)
Get the number of pending jobs.
at line 82
int
delayedSize(UnitEnum|string|null $queue = null)
Get the number of delayed jobs.
at line 94
int
reservedSize(UnitEnum|string|null $queue = null)
Get the number of reserved jobs.
at line 105
int
totalSize()
Get the number of jobs across every queue.
at line 113
int
totalPendingSize()
Get the number of pending jobs across every queue.
at line 124
int
totalDelayedSize()
Get the number of delayed jobs across every queue.
at line 135
int
totalReservedSize()
Get the number of reserved jobs across every queue.
at line 147
Collection
pendingJobs(UnitEnum|string|null $queue = null)
Get the pending jobs for the given queue.
at line 167
Collection
delayedJobs(UnitEnum|string|null $queue = null)
Get the delayed jobs for the given queue.
at line 187
Collection
reservedJobs(UnitEnum|string|null $queue = null)
Get the reserved jobs for the given queue.
at line 206
Collection
allPendingJobs()
Get all pending jobs across every queue.
at line 225
Collection
allDelayedJobs()
Get all delayed jobs across every queue.
at line 244
Collection
allReservedJobs()
Get all reserved jobs across every queue.
at line 260
int|null
creationTimeOfOldestPendingJob(UnitEnum|string|null $queue = null)
Get the creation timestamp of the oldest pending job, excluding delayed jobs.
at line 273
mixed
push(object|string $job, mixed $data = '', UnitEnum|string|null $queue = null)
Push a new job onto the queue.
at line 291
mixed
pushRaw(string $payload, UnitEnum|string|null $queue = null, array $options = [])
Push a raw payload onto the queue.
at line 299
mixed
later(DateInterval|DateTimeInterface|int $delay, object|string $job, mixed $data = '', UnitEnum|string|null $queue = null)
Push a new job onto the queue after (n) seconds.
at line 373
protected array
prepareBatchJobs(array $jobs, mixed $data, string|null $queue)
Prepare the payload and delay for each of the given jobs.
at line 391
protected mixed
enqueueBatch(array $jobs, string|null $queue)
Insert a prepared batch and raise its queue lifecycle events.
at line 451
mixed
release(string $queue, DatabaseJobRecord $job, int $delay)
Release a reserved job back onto the queue after (n) seconds.
at line 459
protected mixed
pushToDatabase(UnitEnum|string|null $queue, string $payload, DateInterval|DateTimeInterface|int $delay = 0, int $attempts = 0)
Push a raw payload to the database with a given delay of (n) seconds.
at line 472
protected array
buildDatabaseRecord(string|null $queue, string $payload, int $availableAt, int $attempts = 0)
Create an array to insert for the given job.
at line 489
Job|null
pop(UnitEnum|string|null $queue = null)
Pop the next job off of the queue.
at line 543
protected DatabaseJobRecord|null
getNextAvailableJob(string|null $queue)
Get the next available job for the queue.
at line 561
protected bool|string
getLockForPopping()
Get the lock required for popping the next job.
at line 573
protected void
isAvailable(Builder $query)
Modify the query to check for available jobs.
at line 584
protected void
isReservedButExpired(Builder $query)
Modify the query to check for jobs that are reserved but have expired.
at line 596
protected DatabaseJob
marshalJob(string $queue, DatabaseJobRecord $job)
Marshal the reserved job into a DatabaseJob instance.
at line 612
protected DatabaseJobRecord
markJobAsReserved(DatabaseJobRecord $job)
Mark the given job ID as reserved.
at line 627
protected bool
causedByReservationQuery(QueryException $exception, ConnectionInterface $database, DatabaseJobRecord $jobRecord)
Determine whether the exception matches this job's reservation update.
Override this alongside markJobAsReserved when changing its SQL or bindings.
at line 651
void
deleteReserved(string $queue, string $id)
Delete a reserved job from the queue.
at line 663
void
deleteAndRelease(string $queue, DatabaseJob $job, int $delay)
Delete a reserved job from the reserved queue and release it.
at line 677
int
clear(UnitEnum|string|null $queue = null)
Delete all of the jobs from the queue.
at line 687
string
getQueue(UnitEnum|string|null $queue)
Get the queue or return the default.
at line 697
ConnectionInterface
getDatabase()
Get the underlying database connection.