Silverstripe
Silverstripe CMSDocs
  • Getting Started
  • Lessons
  • Developer Guides
  • Optional features
    • Advanced Workflow
    • Elemental blocks
    • Content Localisation with Fluent
    • GridField Bulk Editing Tools
    • GridField Extensions
    • Linkfield
    • Login forms
    • Multi-factor authentication (MFA)
    • Non-blocking File-based Sessions
    • Queued Jobs
      • Overview
      • Defining Jobs
      • Default Jobs
      • Immediate Jobs
      • Dependent Jobs
      • Configuring Runners
      • Performance
      • Troubleshooting
      • Unit Testing
    • RealMe
    • Static Publish Queue
    • TagField
    • Taxonomies
    • Text Extraction
    • TOTP Authenticator
    • UserForms
    • WebAuthn Authenticator
  • Upgrading
  • Changelogs
  • Contributing
  • Project Governance
  1. Optional features/
  2. Queued Jobs
Version 5Supported

This version of Silverstripe CMS is still supported though will not receive any additional features.

Go to documentation for the most recent stable version →

Queued jobs#

On this page

  • Installation
  • GitHub repository

This module provides a framework for defining and managing jobs that can be run asynchronously in the background. It allows for scheduling, deferring long-running tasks, and managing them through the CMS.

Installation#

bash
composer require symbiote/silverstripe-queuedjobs

GitHub repository#

https://github.com/silverstripe/silverstripe-queuedjobs

Overview
An introduction to the queued jobs module, covering installation, basic usage, and key concepts like job runners, cleanup, immediate jobs, and job states
Defining Jobs
Creating custom queued jobs, covering the API, constructors, job state management, multiple steps, and advanced setup patterns.
Default Jobs
Automatically created default jobs
Immediate Jobs
Configuring immediate jobs to run as soon as they are queued
Dependent Jobs
Creating jobs that depend on the completion of other jobs
Configuring Runners
Configuring alternative job runners to improve throughput
Performance
Improving the performance of queued jobs
Troubleshooting
Common issues and resolutions
Unit Testing
Writing units tests for queued jobs

Edit on GitHub