Que v0.8.0 Que.Persistence behaviour

Provides a high-level API to interact with Jobs in Database

This module is a behaviour that delegates calls to the specified adapter. It has been designed in a way that it’s easy to write custom adapters for other databases or stores like Redis, even though there are no current plans on supporting anything other than Mnesia.

Summary

Functions

all()

all(worker)

completed()

completed(worker)

destroy(id)

failed()

failed(worker)

find(id)

incomplete()

incomplete(worker)

initialize()

insert(job)

update(job)

Callbacks

all()

Returns all Que.Jobs in the database

all(worker)

Returns all Que.Jobs for the given worker

completed()

Returns completed Que.Jobs from the database

completed(worker)

Returns completed Que.Jobs for the given worker

destroy(id)

Deletes a Que.Job from the database

failed()

Returns failed Que.Jobs from the database

failed(worker)

Returns failed Que.Jobs for the given worker

find(id)

Finds a Que.Job from the database

incomplete()

Returns incomplete Que.Jobs from the database

incomplete(worker)

Returns incomplete Que.Jobs for the given worker

initialize()

Makes sure that the Database is ready to be used

insert(job)

Inserts a Que.Job into the database

update(job)

Updates an existing Que.Job in the database

Functions

all()

all(worker)

completed()

completed(worker)

destroy(id)

failed()

failed(worker)

find(id)

incomplete()

incomplete(worker)

initialize()

insert(job)

update(job)

Callbacks

all()

all() :: [Que.Job.t]

Returns all Que.Jobs in the database.

all(worker)

all(worker :: Que.Worker.t) :: [Que.Job.t]

Returns all Que.Jobs for the given worker.

completed()

completed() :: [Que.Job.t]

Returns completed Que.Jobs from the database.

completed(worker)

completed(worker :: Que.Worker.t) :: [Que.Job.t]

Returns completed Que.Jobs for the given worker.

destroy(id)

destroy(id :: integer) :: :ok | no_return

Deletes a Que.Job from the database.

failed()

failed() :: [Que.Job.t]

Returns failed Que.Jobs from the database.

failed(worker)

failed(worker :: Que.Worker.t) :: [Que.Job.t]

Returns failed Que.Jobs for the given worker.

find(id)

find(id :: integer) :: Que.Job.t | nil

Finds a Que.Job from the database.

Returns the a Job struct if it’s found, otherwise nil.

incomplete()

incomplete() :: [Que.Job.t]

Returns incomplete Que.Jobs from the database.

This includes all Jobs whose status is either :queued or :started but not :failed.

incomplete(worker)

incomplete(worker :: Que.Worker.t) :: [Que.Job.t]

Returns incomplete Que.Jobs for the given worker.

initialize()

initialize() :: :ok | :error

Makes sure that the Database is ready to be used.

This is called when the Que application, specifically Que.Server, starts to make sure that a database exists and is ready to be used.

insert(job)

insert(job :: Que.Job.t) :: Que.Job.t

Inserts a Que.Job into the database.

Returns the same Job struct with the id value set

update(job)

update(job :: Que.Job.t) :: Que.Job.t

Updates an existing Que.Job in the database.

This methods finds the job to update by the given job’s id. If no job with the given id exists, it is inserted as-is. If the id of the given job is nil, it’s still inserted and a valid id is assigned.

Returns the updated job.