Queue operations

Same name and namespace in other branches
  1. 7.x modules/system/system.queue.inc \queue
  2. 9 core/core.api.php \queue
  3. 8.9.x core/core.api.php \queue
  4. 10 core/core.api.php \queue

Queue items to allow later processing.

The queue system allows placing items in a queue and processing them later. The system tries to ensure that only one consumer can process an item.

Creating queues

Before a queue can be used it needs to be created by Drupal\Core\Queue\QueueInterface::createQueue().

Items can be added to the queue by passing an arbitrary data object to Drupal\Core\Queue\QueueInterface::createItem().

To process an item, call Drupal\Core\Queue\QueueInterface::claimItem() and specify how long you want to have a lease for working on that item. When finished processing, the item needs to be deleted by calling Drupal\Core\Queue\QueueInterface::deleteItem(). If the consumer dies, the item will be made available again by the Drupal\Core\Queue\QueueInterface implementation once the lease expires. Another consumer will then be able to receive it when calling Drupal\Core\Queue\QueueInterface::claimItem(). Due to this, the processing code should be aware that an item might be handed over for processing more than once.

The $item object used by the Drupal\Core\Queue\QueueInterface can contain arbitrary metadata depending on the implementation. Systems using the interface should only rely on the data property which will contain the information passed to Drupal\Core\Queue\QueueInterface::createItem(). The full queue item returned by Drupal\Core\Queue\QueueInterface::claimItem() needs to be passed to Drupal\Core\Queue\QueueInterface::deleteItem() once processing is completed.

Queue backends

There are two kinds of queue backends available: reliable, which preserves the order of messages and guarantees that every item will be executed at least once. The non-reliable kind only does a best effort to preserve order in messages and to execute them at least once but there is a small chance that some items get lost. For example, some distributed back-ends like Amazon SQS will be managing jobs for a large set of producers and consumers where a strict FIFO ordering will likely not be preserved. Another example would be an in-memory queue backend which might lose items if it crashes. However, such a backend would be able to deal with significantly more writes than a reliable queue and for many tasks this is more important. Another example is doing Twitter statistics -- the small possibility of losing a few items is insignificant next to power of the queue being able to keep up with writes. As described in the processing section, regardless of the queue being reliable or not, the processing code should be aware that an might be handed over for processing more than once (because the processing code might time out before it finishes).


core/core.api.php, line 1794


Title Sort descending File name Summary
hook_queue_info_alter core/core.api.php Alter cron queue information before cron runs.


Title Sort descending File name Summary
Batch core/lib/Drupal/Core/Queue/Batch.php Defines a batch queue handler used by the Batch API.
BatchMemory core/lib/Drupal/Core/Queue/BatchMemory.php Defines a batch queue handler.
DatabaseQueue core/lib/Drupal/Core/Queue/DatabaseQueue.php Default queue implementation.
Memory core/lib/Drupal/Core/Queue/Memory.php Static queue implementation.
QueueWorker core/lib/Drupal/Core/Queue/Attribute/QueueWorker.php Declare a worker class for processing a queue item.
QueueWorker core/lib/Drupal/Core/Annotation/QueueWorker.php Declare a worker class for processing a queue item.
QueueWorkerBase core/lib/Drupal/Core/Queue/QueueWorkerBase.php Provides a base implementation for a QueueWorker plugin.


Title Sort descending File name Summary
DelayableQueueInterface core/lib/Drupal/Core/Queue/DelayableQueueInterface.php Delayable queue interface.
QueueInterface core/lib/Drupal/Core/Queue/QueueInterface.php Interface for a queue.
QueueWorkerInterface core/lib/Drupal/Core/Queue/QueueWorkerInterface.php Defines an interface for a QueueWorker plugin.
ReliableQueueInterface core/lib/Drupal/Core/Queue/ReliableQueueInterface.php Reliable queue interface.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.