View Source Oban.Job (Oban v2.15.0)
A Job is an Ecto schema used for asynchronous execution.
Job changesets are created by your application code and inserted into the database for asynchronous execution. Jobs can be inserted along with other application data as part of a transaction, which guarantees that jobs will only be triggered from a successful transaction.
Link to this section Summary
Functions
Normalize, blame, and format a job's unsaved_error into the stored error format.
Construct a new job changeset ready for insertion into the database.
A canonical list of all possible job states.
Convert a Job changeset into a map suitable for database insertion.
Link to this section Types
@type args() :: map()
@type changeset() :: Ecto.Changeset.t(t())
@type changeset_list() :: [changeset()]
@type changeset_list_fun() :: (map() -> changeset_list())
@type errors() :: [%{at: DateTime.t(), attempt: pos_integer(), error: binary()}]
@type option() :: {:args, args()} | {:max_attempts, pos_integer()} | {:meta, map()} | {:priority, pos_integer()} | {:queue, atom() | binary()} | {:schedule_in, schedule_in_option()} | {:replace_args, boolean()} | {:replace, [replace_option() | replace_by_state_option()]} | {:scheduled_at, DateTime.t()} | {:tags, tags()} | {:unique, [unique_option()]} | {:worker, atom() | binary()}
@type replace_by_state_option() :: [ available: [replace_option()], cancelled: [replace_option()], completed: [replace_option()], discarded: [replace_option()], executing: [replace_option()], retryable: [replace_option()], scheduled: [replace_option()] ]
@type replace_option() :: [
:args
| :max_attempts
| :meta
| :priority
| :queue
| :scheduled_at
| :tags
| :worker
]
@type schedule_in_option() :: pos_integer() | {pos_integer(), :second | :seconds | :minute | :minutes | :hour | :hours | :day | :days | :week | :weeks}
@type t() :: %Oban.Job{ __meta__: term(), args: args(), attempt: non_neg_integer(), attempted_at: DateTime.t() | nil, attempted_by: [binary()] | nil, cancelled_at: DateTime.t() | nil, completed_at: DateTime.t() | nil, conf: Oban.Config.t() | nil, conflict?: boolean(), discarded_at: DateTime.t() | nil, errors: errors(), id: pos_integer(), inserted_at: DateTime.t(), max_attempts: pos_integer(), meta: map(), priority: non_neg_integer(), queue: binary(), replace: [replace_option() | replace_by_state_option()] | nil, scheduled_at: DateTime.t(), state: binary(), tags: tags(), unique: %{ fields: [unique_field()], period: unique_period(), states: [unique_state()] } | nil, unsaved_error: %{ kind: Exception.kind(), reason: term(), stacktrace: Exception.stacktrace() } | nil, worker: binary() }
@type tags() :: [binary()]
@type unique_field() :: [:args | :meta | :queue | :worker]
@type unique_option() :: {:fields, [unique_field()]} | {:keys, [atom()]} | {:period, unique_period()} | {:states, [unique_state()]}
@type unique_period() :: pos_integer() | :infinity
@type unique_state() :: [
:available
| :cancelled
| :completed
| :discarded
| :executing
| :retryable
| :scheduled
]
Link to this section Functions
Normalize, blame, and format a job's unsaved_error into the stored error format.
Formatted errors are stored in a job's errors field.
Construct a new job changeset ready for insertion into the database.
options
Options
:max_attempts— the maximum number of times a job can be retried if there are errors during execution:meta— a map containing additional information about the job:priority— a numerical indicator from 0 to 3 of how important this job is relative to other jobs in the same queue. The lower the number, the higher priority the job.:queue— a named queue to push the job into. Jobs may be pushed into any queue, regardless of whether jobs are currently being processed for the queue.:replace- a list of keys to replace per state on a unique conflict:scheduled_at- a time in the future after which the job should be executed:schedule_in- the number of seconds until the job should be executed or a tuple containing a number and unit:tags— a list of tags to group and organize related jobs, i.e. to identify scheduled jobs:unique— a keyword list of options specifying how uniqueness will be calculated. The options define which fields will be used, for how long, with which keys, and for which states.:worker— a module to execute the job in. The module must implement theOban.Workerbehaviour.
examples
Examples
Insert a job with the :default queue:
%{id: 1, user_id: 2}
|> Oban.Job.new(queue: :default, worker: MyApp.Worker)
|> Oban.insert()Generate a pre-configured job for MyApp.Worker and push it:
%{id: 1, user_id: 2} |> MyApp.Worker.new() |> Oban.insert()Schedule a job to run in 5 seconds:
%{id: 1} |> MyApp.Worker.new(schedule_in: 5) |> Oban.insert()Schedule a job to run in 5 minutes:
%{id: 1} |> MyApp.Worker.new(schedule_in: {5, :minutes}) |> Oban.insert()Insert a job, ensuring that it is unique within the past minute:
%{id: 1} |> MyApp.Worker.new(unique: [period: 60]) |> Oban.insert()Insert a unique job based only on the worker field, and within multiple states:
fields = [:worker]
states = [:available, :scheduled, :executing, :retryable, :completed]
%{id: 1}
|> MyApp.Worker.new(unique: [fields: fields, period: 60, states: states])
|> Oban.insert()Insert a unique job considering only the worker and specified keys in the args:
keys = [:account_id, :url]
%{account_id: 1, url: "https://example.com"}
|> MyApp.Worker.new(unique: [fields: [:args, :worker], keys: keys])
|> Oban.insert()Insert a unique job considering only specified keys in the meta:
unique = [fields: [:meta], keys: [:slug]]
%{id: 1}
|> MyApp.Worker.new(meta: %{slug: "unique-key"}, unique: unique)
|> Oban.insert()A canonical list of all possible job states.
This may be used to build up :unique options without duplicating states in application code.
examples
Examples
iex> Oban.Job.states() -- [:completed, :discarded]
[:scheduled, :available, :executing, :retryable, :cancelled]
job-state-transitions
Job State Transitions
:scheduled—Jobs inserted withscheduled_atin the future are:scheduled. After thescheduled_attime has ellapsed theOban.Plugins.Stagerwill transition them to:available:available—Jobs without a futurescheduled_attimestamp are inserted as:availableand may execute immediately:executing—Available jobs may be ran, at which point they are:executing:retryable—Jobs that fail and haven't exceeded their max attempts are transitiond to:retryableand rescheduled until after a backoff period. Once the backoff has ellapsed theOban.Plugins.Stagerwill transition them back to:available:completed—Jobs that finish executing succesfully are marked:completed:discarded—Jobs that fail and exhaust their max attempts, or return a:discardtuple during execution, are marked:discarded:cancelled—Jobs that are cancelled intentionally
@spec to_map(Ecto.Changeset.t(t())) :: map()
Convert a Job changeset into a map suitable for database insertion.
examples
Examples
Convert a worker generated changeset into a plain map:
%{id: 123}
|> MyApp.Worker.new()
|> Oban.Job.to_map()