Scheduled task

What are scheduled tasks?

Scheduled tasks are a way to schedule messages to the queue on time. Shopware uses it to run cleanup tasks, update tasks, and other non-time critical tasks in the background.

Default scheduled tasks

These tasks are registered by default:

Name	Run interval (seconds)
log_entry.cleanup	86400
shopware.invalidate_cache	20
app_update	86400
app_delete	86400
version.cleanup	86400
webhook_event_log.cleanup	86400
sales_channel_context.cleanup	86400
product_keyword_dictionary.cleanup	604800
product_download.media.cleanup	2628000
delete_newsletter_recipient_task	86400
product_stream.mapping.update	86400
product_export_generate_task	60
import_export_file.cleanup	86400
shopware.sitemap_generate	86400
cart.cleanup	86400
shopware.elasticsearch.create.alias	300

INFO

Some tasks like shopware.elasticsearch.create.alias and shopware.invalidate_cache are only running when necessary. Elasticsearch task only runs when an Elasticsearch server is configured and enabled.

Creating a scheduled task

Add scheduled task

INFO

The following commands or flags (--no-wait) are available starting with Shopware 6.5.5.0.

List all scheduled tasks

You can list all scheduled tasks with bin/console scheduled-task:list command.

Running scheduled tasks

To run the scheduled tasks, you must set up a background worker like the Message Queue and run the command bin/console scheduled-task:run. The command schedules all tasks to the queue and waits until a task needs to be scheduled. It consumes little CPU time or memory.

You can use the flag --no-wait and run the command from an operating system scheduler like cron. Check your scheduled task interval to determine the best interval to trigger the command. Example:

*/5 * * * * /usr/bin/php /var/www/html/bin/console scheduled-task:run --no-wait

Debugging scheduled tasks

You can directly run a single scheduled task without the queue. This is useful for debugging purposes or to have better control of when and which tasks are executed. You can use bin/console scheduled-task:run-single <task-name> to run a single task. Example:

bin/console scheduled-task:run-single log_entry.cleanup