1. class
  2. Hypervel
  3. \
  4. Queue
  5. \
  6. DatabaseQueue

DatabaseQueue

class DatabaseQueue extends Queue implements Queue, ClearableQueue

Traits

InteractsWithTime
ReadsQueueAttributes
ReadsClassAttributes

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 all 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

int
secondsUntil(DateInterval|DateTimeInterface|int $delay)

Get the number of seconds until the given DateTime.

from  InteractsWithTime
int
availableAt(DateInterval|DateTimeInterface|int|null $delay = 0)

Get the "available at" UNIX timestamp.

from  InteractsWithTime
DateTimeInterface|int
parseDateInterval(DateInterval|DateTimeInterface|int|null $delay)

If the given value is an interval, convert it to a DateTime instance.

from  InteractsWithTime
int
currentTime()

Get the current system time as a UNIX timestamp.

from  InteractsWithTime
string
runTimeForHumans(float $startTime, float|null $endTime = null)

Given a start time, format the total run time for human readability.

from  InteractsWithTime
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.

from  ReadsClassAttributes
mixed
extractAttributeValue(object $instance)

Extract the value from an attribute instance.

from  ReadsClassAttributes
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.

from  ReadsClassAttributes
bool
propertyOverridesAttribute(object $target, ReflectionClass $reflection, string|null $property, ReflectionClass $attributeDeclaringClass)

Determine if a property declared on a child class overrides an inherited attribute.

from  ReadsClassAttributes
mixed
pushOn(string|null $queue, object|string $job, mixed $data = '')

Push a new job onto the queue.

from  Queue
mixed
laterOn(string|null $queue, DateInterval|DateTimeInterface|int $delay, object|string $job, mixed $data = '')

Push a new job onto a specific queue after (n) seconds.

from  Queue
mixed
bulk(array $jobs, mixed $data = '', string|null $queue = null)

Push an array of jobs onto the queue.

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.

from  Queue
array
createPayloadArray(array|object|string $job, string|null $queue, mixed $data = '')

Create a payload array from the given job and data.

from  Queue
array
createObjectPayload(object $job, string|null $queue)

Create a payload for an object-based queue handler.

from  Queue
string
getDisplayName(object $job)

Get the display name for the given job.

from  Queue
mixed
getJobTries(mixed $job)

Get the maximum number of attempts for an object-based queue handler.

from  Queue
mixed
getJobBackoff(mixed $job)

Get the backoff for an object-based queue handler.

from  Queue
mixed
getJobExpiration(mixed $job)

Get the expiration timestamp for an object-based queue handler.

from  Queue
bool
jobShouldBeEncrypted(object $job)

Determine if the job should be encrypted.

from  Queue
array
createStringPayload(array|string $job, string|null $queue, mixed $data)

Create a typical, string based queue payload array.

from  Queue
static void
createPayloadUsing(callable|null $callback)

Register a callback to be executed when creating job payloads.

from  Queue
array
withCreatePayloadHooks(string|null $queue, array $payload)

Create the given payload using any registered payload hooks.

from  Queue
Queue
setAfterCommitDispatcher(Closure|null $dispatcher)

Set the dispatcher for after-commit queue operations.

from  Queue
mixed
enqueueUsing(object|string $job, string $payload, string|null $queue, DateInterval|DateTimeInterface|int|null $delay, callable $callback)

Enqueue a job using the given callback.

from  Queue
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.

from  Queue
bool
shouldDispatchAfterCommit(object|string $job)

Determine if the job should be dispatched after all database transactions have committed.

from  Queue
void
addUniqueJobRollbackCallback(DatabaseTransactionsManager $transactions, object|string $job)

Register a transaction rollback callback that releases the unique lock for the given job.

from  Queue
void
addDebouncedJobRollbackCallback(DatabaseTransactionsManager $transactions, object|string $job)

Register a transaction rollback callback that releases the debounce token for the given job.

from  Queue
void
raiseJobQueueingEvent(string|null $queue, object|string $job, string $payload, DateInterval|DateTimeInterface|int|null $delay)

Raise the job queueing event.

from  Queue
void
raiseJobQueuedEvent(string|null $queue, mixed $jobId, object|string $job, string $payload, DateInterval|DateTimeInterface|int|null $delay)

Raise the job queued event.

from  Queue
string
getConnectionName()

Get the connection name for the queue.

from  Queue
Queue
setConnectionName(string $name)

Set the connection name for the queue.

from  Queue
array
getConfig()

Get the queue configuration array.

from  Queue
Queue
setConfig(array $config)

Set the queue configuration array.

from  Queue
Container
getContainer()

Get the container instance being used by the connection.

from  Queue
Queue
setContainer(Container $container)

Set the IoC container instance.

from  Queue
static void
flushState()

Flush all static state.

from  Queue
__construct(ConnectionResolverInterface $resolver, string|null $connection, string $table, string $default = 'default', int|null $retryAfter = 60, bool $dispatchAfterCommit = false)

Create a new database queue instance.

int
size(string|null $queue = null)

Get the size of the queue.

int
pendingSize(string|null $queue = null)

Get the number of pending jobs.

int
delayedSize(string|null $queue = null)

Get the number of delayed jobs.

int
reservedSize(string|null $queue = null)

Get the number of reserved jobs.

Collection
pendingJobs(string|null $queue = null)

Get the pending jobs for the given queue.

Collection
delayedJobs(string|null $queue = null)

Get the delayed jobs for the given queue.

Collection
reservedJobs(string|null $queue = null)

Get the reserved jobs for the given queue.

Collection
allPendingJobs()

Get all pending jobs across every queue.

Collection
allDelayedJobs()

Get all delayed jobs across every queue.

Collection
allReservedJobs()

Get all reserved jobs across every queue.

int|null
creationTimeOfOldestPendingJob(string|null $queue = null)

Get the creation timestamp of the oldest pending job, excluding delayed jobs.

mixed
push(object|string $job, mixed $data = '', string|null $queue = null)

Push a new job onto the queue.

mixed
pushRaw(string $payload, string|null $queue = null, array $options = [])

Push a raw payload onto the queue.

mixed
later(DateInterval|DateTimeInterface|int $delay, object|string $job, mixed $data = '', string|null $queue = null)

Push a new job onto the queue after (n) seconds.

mixed
release(string $queue, DatabaseJobRecord $job, int $delay)

Release a reserved job back onto the queue after (n) seconds.

mixed
pushToDatabase(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.

array
buildDatabaseRecord(string|null $queue, string $payload, int $availableAt, int $attempts = 0)

Create an array to insert for the given job.

Job|null
pop(string|null $queue = null)

Pop the next job off of the queue.

DatabaseJobRecord|null
getNextAvailableJob(string|null $queue)

Get the next available job for the queue.

bool|string
getLockForPopping()

Get the lock required for popping the next job.

void
isAvailable(Builder $query)

Modify the query to check for available jobs.

void
isReservedButExpired(Builder $query)

Modify the query to check for jobs that are reserved but have expired.

DatabaseJob
marshalJob(string $queue, DatabaseJobRecord $job)

Marshal the reserved job into a DatabaseJob instance.

DatabaseJobRecord
markJobAsReserved(DatabaseJobRecord $job)

Mark the given job ID as reserved.

void
deleteReserved(string $queue, string $id)

Delete a reserved job from the queue.

void
deleteAndRelease(string $queue, DatabaseJob $job, int $delay)

Delete a reserved job from the reserved queue and release it.

int
clear(string|null $queue)

Delete all of the jobs from the queue.

string
getQueue(string|null $queue)

Get the queue or return the default.

ConnectionInterface
getDatabase()

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.

Parameters

DateInterval|DateTimeInterface|int $delay

Return Value

int

in InteractsWithTime at line 29
protected int availableAt(DateInterval|DateTimeInterface|int|null $delay = 0)

Get the "available at" UNIX timestamp.

Parameters

DateInterval|DateTimeInterface|int|null $delay

Return Value

int

in InteractsWithTime at line 41
protected DateTimeInterface|int parseDateInterval(DateInterval|DateTimeInterface|int|null $delay)

If the given value is an interval, convert it to a DateTime instance.

Parameters

DateInterval|DateTimeInterface|int|null $delay

Return Value

DateTimeInterface|int

in InteractsWithTime at line 57
protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

in InteractsWithTime at line 65
protected string runTimeForHumans(float $startTime, float|null $endTime = null)

Given a start time, format the total run time for human readability.

Parameters

float $startTime
float|null $endTime

Return Value

string

in ReadsClassAttributes at line 15
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.

Parameters

object $target
string $attributeClass
string|null $property
mixed $default

Return Value

mixed

in ReadsClassAttributes at line 44
protected mixed extractAttributeValue(object $instance)

Extract the value from an attribute instance.

Parameters

object $instance

Return Value

mixed

in ReadsClassAttributes at line 54
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.

Parameters

object $target
string $attributeClass
ReflectionClass|null $declaringClass

Return Value

object|null

in ReadsClassAttributes at line 70
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.

Parameters

object $target
ReflectionClass $reflection
string|null $property
ReflectionClass $attributeDeclaringClass

Return Value

bool

in Queue at line 82
mixed pushOn(string|null $queue, object|string $job, mixed $data = '')

Push a new job onto the queue.

Parameters

string|null $queue
object|string $job
mixed $data

Return Value

mixed

in Queue at line 91
mixed laterOn(string|null $queue, DateInterval|DateTimeInterface|int $delay, object|string $job, mixed $data = '')

Push a new job onto a specific queue after (n) seconds.

Parameters

string|null $queue
DateInterval|DateTimeInterface|int $delay
object|string $job
mixed $data

Return Value

mixed

at line 267
mixed bulk(array $jobs, mixed $data = '', string|null $queue = null)

Push an array of jobs onto the queue.

Parameters

array $jobs
mixed $data
string|null $queue

Return Value

mixed

in Queue at line 117
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.

Parameters

array|object|string $job
string|null $queue
mixed $data
DateInterval|DateTimeInterface|int|null $delay

Return Value

string

Exceptions

InvalidPayloadException

in Queue at line 150
protected array createPayloadArray(array|object|string $job, string|null $queue, mixed $data = '')

Create a payload array from the given job and data.

Parameters

array|object|string $job
string|null $queue
mixed $data

Return Value

array

in Queue at line 160
protected array createObjectPayload(object $job, string|null $queue)

Create a payload for an object-based queue handler.

Parameters

object $job
string|null $queue

Return Value

array

in Queue at line 214
protected string getDisplayName(object $job)

Get the display name for the given job.

Parameters

object $job

Return Value

string

in Queue at line 223
mixed getJobTries(mixed $job)

Get the maximum number of attempts for an object-based queue handler.

Parameters

mixed $job

Return Value

mixed

in Queue at line 237
mixed getJobBackoff(mixed $job)

Get the backoff for an object-based queue handler.

Parameters

mixed $job

Return Value

mixed

in Queue at line 257
mixed getJobExpiration(mixed $job)

Get the expiration timestamp for an object-based queue handler.

Parameters

mixed $job

Return Value

mixed

in Queue at line 272
protected bool jobShouldBeEncrypted(object $job)

Determine if the job should be encrypted.

Parameters

object $job

Return Value

bool

in Queue at line 284
protected array createStringPayload(array|string $job, string|null $queue, mixed $data)

Create a typical, string based queue payload array.

Parameters

array|string $job
string|null $queue
mixed $data

Return Value

array

in Queue at line 307
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.

Parameters

callable|null $callback

Return Value

void

in Queue at line 319
protected array withCreatePayloadHooks(string|null $queue, array $payload)

Create the given payload using any registered payload hooks.

Parameters

string|null $queue
array $payload

Return Value

array

in Queue at line 335
Queue setAfterCommitDispatcher(Closure|null $dispatcher)

Set the dispatcher for after-commit queue operations.

Parameters

Closure|null $dispatcher

Return Value

Queue

in Queue at line 350
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.

Parameters

object|string $job
string $payload
string|null $queue
DateInterval|DateTimeInterface|int|null $delay
callable $callback

Return Value

mixed

in Queue at line 388
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.

Parameters

object|string $job
string $payload
string|null $queue
DateInterval|DateTimeInterface|int|null $delay
callable $callback

Return Value

mixed

in Queue at line 402
protected bool shouldDispatchAfterCommit(object|string $job)

Determine if the job should be dispatched after all database transactions have committed.

Parameters

object|string $job

Return Value

bool

in Queue at line 418
protected void addUniqueJobRollbackCallback(DatabaseTransactionsManager $transactions, object|string $job)

Register a transaction rollback callback that releases the unique lock for the given job.

Parameters

DatabaseTransactionsManager $transactions
object|string $job

Return Value

void

in Queue at line 434
protected void addDebouncedJobRollbackCallback(DatabaseTransactionsManager $transactions, object|string $job)

Register a transaction rollback callback that releases the debounce token for the given job.

Parameters

DatabaseTransactionsManager $transactions
object|string $job

Return Value

void

in Queue at line 452
protected void raiseJobQueueingEvent(string|null $queue, object|string $job, string $payload, DateInterval|DateTimeInterface|int|null $delay)

Raise the job queueing event.

Parameters

string|null $queue
object|string $job
string $payload
DateInterval|DateTimeInterface|int|null $delay

Return Value

void

in Queue at line 473
protected void raiseJobQueuedEvent(string|null $queue, mixed $jobId, object|string $job, string $payload, DateInterval|DateTimeInterface|int|null $delay)

Raise the job queued event.

Parameters

string|null $queue
mixed $jobId
object|string $job
string $payload
DateInterval|DateTimeInterface|int|null $delay

Return Value

void

in Queue at line 492
string getConnectionName()

Get the connection name for the queue.

Return Value

string

in Queue at line 504
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.

Parameters

string $name

Return Value

Queue

in Queue at line 514
array getConfig()

Get the queue configuration array.

Return Value

array

in Queue at line 526
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.

Parameters

array $config

Return Value

Queue

in Queue at line 536
Container getContainer()

Get the container instance being used by the connection.

Return Value

Container

in Queue at line 548
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.

Parameters

Container $container

Return Value

Queue

in Queue at line 558
static void flushState()

Flush all static state.

Return Value

void

at line 36
__construct(ConnectionResolverInterface $resolver, string|null $connection, string $table, string $default = 'default', int|null $retryAfter = 60, bool $dispatchAfterCommit = false)

Create a new database queue instance.

Parameters

ConnectionResolverInterface $resolver

the database connection resolver instance
string|null $connection

the database connection that holds the jobs
string $table

the database table that holds the jobs
string $default

the name of the default queue
int|null $retryAfter

the expiration time of a job
bool $dispatchAfterCommit

at line 49
int size(string|null $queue = null)

Get the size of the queue.

Parameters

string|null $queue

Return Value

int

at line 59
int pendingSize(string|null $queue = null)

Get the number of pending jobs.

Parameters

string|null $queue

Return Value

int

at line 71
int delayedSize(string|null $queue = null)

Get the number of delayed jobs.

Parameters

string|null $queue

Return Value

int

at line 83
int reservedSize(string|null $queue = null)

Get the number of reserved jobs.

Parameters

string|null $queue

Return Value

int

at line 96
Collection pendingJobs(string|null $queue = null)

Get the pending jobs for the given queue.

Parameters

string|null $queue

Return Value

Collection

at line 116
Collection delayedJobs(string|null $queue = null)

Get the delayed jobs for the given queue.

Parameters

string|null $queue

Return Value

Collection

at line 136
Collection reservedJobs(string|null $queue = null)

Get the reserved jobs for the given queue.

Parameters

string|null $queue

Return Value

Collection

at line 155
Collection allPendingJobs()

Get all pending jobs across every queue.

Return Value

Collection

at line 174
Collection allDelayedJobs()

Get all delayed jobs across every queue.

Return Value

Collection

at line 193
Collection allReservedJobs()

Get all reserved jobs across every queue.

Return Value

Collection

at line 209
int|null creationTimeOfOldestPendingJob(string|null $queue = null)

Get the creation timestamp of the oldest pending job, excluding delayed jobs.

Parameters

string|null $queue

Return Value

int|null

at line 222
mixed push(object|string $job, mixed $data = '', string|null $queue = null)

Push a new job onto the queue.

Parameters

object|string $job
mixed $data
string|null $queue

Return Value

mixed

at line 238
mixed pushRaw(string $payload, string|null $queue = null, array $options = [])

Push a raw payload onto the queue.

Parameters

string $payload
string|null $queue
array $options

Return Value

mixed

at line 246
mixed later(DateInterval|DateTimeInterface|int $delay, object|string $job, mixed $data = '', string|null $queue = null)

Push a new job onto the queue after (n) seconds.

Parameters

DateInterval|DateTimeInterface|int $delay
object|string $job
mixed $data
string|null $queue

Return Value

mixed

at line 291
mixed release(string $queue, DatabaseJobRecord $job, int $delay)

Release a reserved job back onto the queue after (n) seconds.

Parameters

string $queue
DatabaseJobRecord $job
int $delay

Return Value

mixed

at line 299
protected mixed pushToDatabase(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.

Parameters

string|null $queue
string $payload
DateInterval|DateTimeInterface|int $delay
int $attempts

Return Value

mixed

at line 312
protected array buildDatabaseRecord(string|null $queue, string $payload, int $availableAt, int $attempts = 0)

Create an array to insert for the given job.

Parameters

string|null $queue
string $payload
int $availableAt
int $attempts

Return Value

array

at line 329
Job|null pop(string|null $queue = null)

Pop the next job off of the queue.

Parameters

string|null $queue

Return Value

Job|null

Exceptions

Throwable

at line 343
protected DatabaseJobRecord|null getNextAvailableJob(string|null $queue)

Get the next available job for the queue.

Parameters

string|null $queue

Return Value

DatabaseJobRecord|null

at line 361
protected bool|string getLockForPopping()

Get the lock required for popping the next job.

Return Value

bool|string

at line 394
protected void isAvailable(Builder $query)

Modify the query to check for available jobs.

Parameters

Builder $query

Return Value

void

at line 405
protected void isReservedButExpired(Builder $query)

Modify the query to check for jobs that are reserved but have expired.

Parameters

Builder $query

Return Value

void

at line 417
protected DatabaseJob marshalJob(string $queue, DatabaseJobRecord $job)

Marshal the reserved job into a DatabaseJob instance.

Parameters

string $queue
DatabaseJobRecord $job

Return Value

DatabaseJob

at line 433
protected DatabaseJobRecord markJobAsReserved(DatabaseJobRecord $job)

Mark the given job ID as reserved.

Parameters

DatabaseJobRecord $job

Return Value

DatabaseJobRecord

at line 448
void deleteReserved(string $queue, string $id)

Delete a reserved job from the queue.

Parameters

string $queue
string $id

Return Value

void

Exceptions

Throwable

at line 460
void deleteAndRelease(string $queue, DatabaseJob $job, int $delay)

Delete a reserved job from the reserved queue and release it.

Parameters

string $queue
DatabaseJob $job
int $delay

Return Value

void

at line 474
int clear(string|null $queue)

Delete all of the jobs from the queue.

Parameters

string|null $queue

Return Value

int

at line 484
string getQueue(string|null $queue)

Get the queue or return the default.

Parameters

string|null $queue

Return Value

string

at line 492
ConnectionInterface getDatabase()

Get the underlying database connection.

Return Value

ConnectionInterface