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

Returns all Que.Jobs in the database.

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

Returns all Que.Jobs for the given worker.

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

Returns completed Que.Jobs from the database.

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

Returns completed Que.Jobs for the given worker.

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

Deletes a Que.Job from the database.

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

Returns failed Que.Jobs from the database.

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

Returns failed Que.Jobs for the given worker.

@callback 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.

@callback 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.

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

Returns incomplete Que.Jobs for the given worker.

@callback 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.

@callback 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

@callback 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.