@callback add_job(storage_pid :: storage_pid(), job :: Quantum.Job.t()) :: :ok

Save new job in storage.

@callback child_spec(init_arg :: Keyword.t()) :: Supervisor.child_spec()

Storage child spec

If the storage does not need a process, specify a function that returns :ignore.

Values

• :scheduler - The Scheduler

@callback delete_job(storage_pid :: storage_pid(), job :: Quantum.Job.name()) :: :ok

Delete new job in storage.

@callback jobs(storage_pid :: storage_pid()) :: :not_applicable | [Quantum.Job.t()]

Load saved jobs from storage.

Returns :not_applicable if the storage has never received an add_job call or after it has been purged. In this case the jobs from the configuration will be loaded.

@callback last_execution_date(storage_pid :: storage_pid()) ::
  :unknown | NaiveDateTime.t()

Load last execution time from storage.

Returns :unknown if the storage does not know the last execution time. In this case all jobs will be run at the next applicable date.

@callback purge(storage_pid :: storage_pid()) :: :ok

Purge all date from storage and go back to initial state.

@callback update_job(storage_pid :: storage_pid(), job :: Quantum.Job.t()) :: :ok

Updates existing job in storage.

This callback is optional. If not implemented then the delete_job/2 and then the add_job/2 callbacks will be called instead.

@callback update_job_state(
  storage_pid :: storage_pid(),
  job :: Quantum.Job.name(),
  state :: Quantum.Job.state()
) :: :ok

Change Job State from given job.

@callback update_last_execution_date(
  storage_pid :: storage_pid(),
  last_execution_date :: NaiveDateTime.t()
) :: :ok

Update last execution time to given date.