README

Additional Drush commands for Advanced Queue.

Note

This module is mainly for use during development, but in rare cases it may also be used in production.

Installation

composer require --dev itk-dev/itkdev_advancedqueue_addons
drush pm:install itkdev_advancedqueue_addons

Usage

The module provides three Drush commands:

advancedqueue:queue:list:jobs

List jobs command.

Examples:
 advancedqueue:queue:list:jobs my_queue                                   Show jobs in "my_queue" queue.
 advancedqueue:queue:list:jobs my_queue 87                                Show job with ID 87 in "my_queue" queue.
 advancedqueue:queue:list:jobs my_queue --show-payload                    Show job payload.
 advancedqueue:queue:list:jobs my_queue --search horse                    List jobs where "horse" is a value in the payload.
 advancedqueue:queue:list:jobs my_queue --search handler.id=87            List jobs where payload.handler.id has the (string) value "87".
 advancedqueue:queue:list:jobs my_queue --search '{"submissionId": "87"}' List jobs where payload contains the specified JSON object.

Arguments:
 queue_id The queue ID.
 [job_id] Job ID

Options:
--show-payload    Show payload
--search[=SEARCH] Search for a value, by path or by a JSON object
--limit[=LIMIT]   Maximum number of jobs to return (at most 100) [default: 1]

Global options:
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-y, --yes            Auto-accept the default for all user prompts. Equivalent to --no-interaction.
-l, --uri=URI        A base URL for building links and selecting a multi-site. Defaults to https://default.
                     To see all global options, run `drush topic` and pick the first choice.

advancedqueue:queue:job:process

Process job command.

Examples:
 advancedqueue:queue:job:process my_queue 87                Ask for confirmation and process job with ID 87 in "my_queue" queue.
 advancedqueue:queue:job:process my_queue 87 --yes          Process job with ID 87 in "my_queue" queue without confirmation.
 advancedqueue:queue:job:process my_queue 87 --show-payload Show job payload and process job with ID 87 in "my_queue" queue.

Arguments:
 queue_id The queue ID.
 job_id   Job ID

Options:
--show-payload Show payload

Global options:
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-y, --yes            Auto-accept the default for all user prompts. Equivalent to --no-interaction.
-l, --uri=URI        A base URL for building links and selecting a multi-site. Defaults to https://default.
                     To see all global options, run `drush topic` and pick the first choice.

advancedqueue:queue:job:set-payload-value

Set job payload value.

Examples:
 advancedqueue:queue:job:set-payload-value my_queue 87 --set person.name=James                               Set string value
 advancedqueue:queue:job:set-payload-value my_queue 87 --set-int person.age=61                               Set integer value
 advancedqueue:queue:job:set-payload-value my_queue 87 --unset person.address                                Unset value
 advancedqueue:queue:job:set-payload-value my_queue 87 --set person.name=James --unset person.address --diff Perform multiple operations and preview changes
 advancedqueue:queue:job:set-payload-value my_queue 87 --edit                                                Edit payload interactively in vi
 advancedqueue:queue:job:set-payload-value my_queue 87 --edit --diff                                         Edit payload interactively and preview final changes
 advancedqueue:queue:job:set-payload-value my_queue 87 --set name=test --edit                                Set value and edit result interactively
 advancedqueue:queue:job:set-payload-value my_queue 87 --edit --editor=nano                                  Edit value using nano (for experts!)

Arguments:
 queue_id The queue ID.
 job_id   Job ID

Options:
--diff            Show payload diff
--set=SET         Set string value
--set-int=SET-INT Set integer value
--unset=UNSET     Unset value
--edit            Edit payload interactively. Editing will be performed after all set and unset operations have been performed.
--editor[=EDITOR] The editor to use [default: vi]

Global options:
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-y, --yes            Auto-accept the default for all user prompts. Equivalent to --no-interaction.
-l, --uri=URI        A base URL for building links and selecting a multi-site. Defaults to https://default.
                     To see all global options, run `drush topic` and pick the first choice.

Development

We use DDEV and friends for development – see README.ddev.md for details.

Important

2026-11-06: We lock phpstan/phpstan to version 2.3.3 as a temporary workaround for the issue reported in rectorphp/rector#9947.

We use palantirnet/drupal-rector to run Rector. drupal-rector pulls in rectorphp/rector, but conflicts with "rector/rector": ">=2.6.2" and therefore we cannot (yet) upgrade to rector/rector:^2.8.3.

See rectorphp/rector#9947 (comment) for details.

Documentation

We use Markdown Code Runner to insert Drush command output into README.md.

Run

task docs:update

to update the documentation.

Note

THe docs:update task runs only on the darwin platform (cf. Platforms and shells).