Scheduling Jobs#

The Jobs package also allows you to schedule jobs to occur at certain points in time.

Starting the scheduler worker#

The scheduler requires a separate worker process to be running, similar to the queue worker. You can start the worker by running this command:

vapor run jobs --scheduled

Creating a ScheduledJob#

To being, start by creating a new ScheduledJob:

import Vapor
import Jobs

struct CleanupJob: ScheduledJob {
    // Add extra services here via dependency injection, if you need them.

    func run(context: JobContext) -> EventLoopFuture<Void> {
        // Do some work here, perhaps queue up another job.
        return context.eventLoop.makeSucceededFuture(())
    }
}

Then, in your configure code, register the scheduled job:

services.register { container -> JobsConfig in
    var jobsConfig = JobsConfig()
    
    jobsConfig.schedule(CleanupJob())
        .yearly()
        .in(.may)
        .on(23)
        .at(.noon)

    return jobsConfig
}

The job in the example above will be run every year on May 23rd at 12:00 PM.

Available builder methods#

There are five main methods that can be called on a scheduler, each of which creates its respective builder object that contains more helper methods. You should continue building out a scheduler object until the compiler does not give you a warning about an unused result. See below for all available methods:

Available helpers#

Jobs ships with some helpers enums to make scheduling a bit easier:

To use the helper enum, call in to the appropriate modifier on the helper function and pass the value. For example:

// Every year in January 
.yearly().in(.january)

// Every month on the first day 
.monthly().on(.first)

// Every week on Sunday 
.weekly().on(.sunday)

// Every day at midnight
.daily().at(.midnight)