Feature/599 - Add a database Queue driver

[josephmancuso]

Closes #599

Documentation

Install from this branch

$ pip install https://github.com/masoniteframework/core/archive/feature/599.zip

First you will need to create the migration for your queue jobs:

$ craft queue:table --jobs

If you want to have a table where failed jobs will be stored, you can create a migration for that table as well. If this table does not exist, any failed jobs will simply stay failed.

$ craft queue:table --failed

Change the database configuration to use the database driver:

DRIVER = 'database'

Or you can leave the queue driver as is and specify the driver directly with the Queue class:

from masonite.queue import Queue

def show(self, queue: Queue):
    queue.driver('database').push(..)

Waiting

With the database driver, you have the ability to use the wait keyword. To queue a job to run 10 minutes from now you can do something like:

from masonite.queue import Queue
from app.jobs import SomeJob

def show(self, queue: Queue):
    queue.driver('database').push(SomeJob, args=(arg1, arg2), wait="10 minutes")

Running the worker

The database driver, like the amqp driver, requires a worker to be running. You can run the worker by using the queue:work command:

$ craft queue:work --driver database

This will start a worker that will poll the database for new jobs every 5 seconds. Once new jobs are found it will run them all and then continue waiting for new jobs. If any jobs fail they will run 3 more times. If the job still fails it will be added to the failed_jobs if one exists. If one does not exist it will stay failed inside the queue_jobs table.

You can still run failed jobs by running

$ craft queue:work --driver database --failed