Search
Oban
v2.19.4
v2.19.3
v2.19.2
v2.19.1
v2.19.0
v2.18.3
v2.18.2
v2.18.1
v2.18.0
v2.17.12
v2.17.11
v2.17.10
v2.17.9
v2.17.8
v2.17.7
v2.17.6
v2.17.5
v2.17.4
v2.17.3
v2.17.2
v2.17.1
v2.17.0
v2.16.3
v2.16.2
v2.16.1
v2.16.0
v2.15.4
v2.15.3
v2.15.2
v2.15.1
v2.15.0
v2.14.2
v2.14.1
v2.14.0
v2.13.6
v2.13.5
v2.13.4
v2.13.3
v2.13.2
v2.13.1
v2.13.0
v2.12.1
v2.12.0
v2.11.3
v2.11.2
v2.11.1
v2.11.0
v2.10.1
v2.10.0
v2.9.2
v2.9.1
v2.9.0
v2.8.0
v2.7.2
v2.7.1
v2.7.0
v2.6.1
v2.6.0
v2.5.0
v2.4.3
v2.4.2
v2.4.1
v2.4.0
v2.3.4
v2.3.3
v2.3.2
v2.3.1
v2.2.0
v2.1.0
v2.0.0
v2.0.0-rc.3
v2.0.0-rc.2
v2.0.0-rc.1
v2.0.0-rc.0
v1.2.0
v1.1.0
v1.0.0
v1.0.0-rc.2
v1.0.0-rc.1
v0.12.1
v0.12.0
v0.11.1
v0.11.0
v0.10.1
v0.10.0
v0.9.0
v0.8.1
v0.8.0
v0.7.1
v0.7.0
v0.6.0
v0.5.0
v0.4.0
v0.3.0
v0.2.0
v0.1.0
GUIDES
Modules
Oban
Sections
Testing
Error Handling
Instrumentation and Logging
Isolation
Summary
Types
changeset_or_fun/0
changeset_wrapper/0
changesets_or_wrapper/0
changesets_or_wrapper_or_fun/0
drain_option/0
drain_result/0
name/0
option/0
queue_name/0
queue_option/0
queue_state/0
Functions
cancel_all_jobs/2
cancel_job/2
check_queue/2
child_spec/1
config/1
drain_queue/2
insert!/3
insert/3
insert/5
insert_all/3
insert_all/5
pause_queue/2
resume_queue/2
retry_all_jobs/2
retry_job/2
scale_queue/2
start_link/1
start_queue/2
stop_queue/2
whereis/1
Oban.Job
Summary
Types
args/0
changeset/0
changeset_fun/0
changeset_list/0
changeset_list_fun/0
errors/0
option/0
replace_option/0
schedule_in_option/0
t/0
tags/0
unique_field/0
unique_option/0
unique_period/0
unique_state/0
Functions
new/2
states/0
to_map/1
validate_keys/3
Oban.Migrations
Sections
Usage
Isolation with Prefixes
Migrating Without Ecto
Summary
Functions
down/1
up/1
Oban.Telemetry
Sections
Default Logger
Examples
Summary
Functions
attach_default_logger/1
Oban.Testing
Sections
Using in Tests
Example
Matching Scheduled Jobs and Timestamps
Adding to Case Templates
Summary
Functions
all_enqueued/2
assert_enqueued/2
assert_enqueued/3
perform_job/3
refute_enqueued/2
refute_enqueued/3
with_testing_mode/2
Oban.Worker
Sections
Defining Workers
Enqueuing Jobs
Customizing Backoff
Snoozing jobs
Limiting Execution Time
Summary
Types
result/0
t/0
Callbacks
backoff/1
new/2
perform/1
timeout/1
Functions
from_string/1
to_string/1
Plugins
Oban.Plugins.Cron
Sections
Using the Plugin
Options
Instrumenting with Telemetry
Summary
Types
cron_input/0
expression/0
option/0
Functions
child_spec/1
parse/1
Oban.Plugins.Gossip
Sections
Using the Plugin
Options
Instrumenting with Telemetry
Summary
Types
option/0
Functions
child_spec/1
Oban.Plugins.Lifeline
Sections
Using the Plugin
Options
Instrumenting with Telemetry
Summary
Types
option/0
Functions
child_spec/1
Oban.Plugins.Pruner
Sections
Using the Plugin
Options
Instrumenting with Telemetry
Summary
Types
option/0
Functions
child_spec/1
Oban.Plugins.Reindexer
Sections
Using the Plugin
Options
Summary
Types
option/0
Functions
child_spec/1
Oban.Plugins.Repeater
Sections
Using the Plugin
Options
Summary
Types
option/0
Functions
child_spec/1
Oban.Plugins.Stager
Sections
Options
Instrumenting with Telemetry
Summary
Types
option/0
Functions
child_spec/1
Extending
Oban.Config
Summary
Types
t/0
Functions
new/1
validate/1
Oban.Engine
Summary
Types
conf/0
job/0
meta/0
opts/0
queryable/0
running/0
seconds/0
Callbacks
cancel_all_jobs/2
cancel_job/2
check_meta/3
complete_job/2
discard_job/2
error_job/3
fetch_jobs/3
init/2
insert_all_jobs/3
insert_all_jobs/5
insert_job/3
insert_job/5
put_meta/4
refresh/2
retry_all_jobs/2
retry_job/2
shutdown/2
snooze_job/3
Oban.Notifier
Sections
Channels
Examples
Summary
Types
channel/0
option/0
server/0
Callbacks
listen/2
notify/3
start_link/1
unlisten/2
Functions
listen/2
notify/3
unlisten/2
Oban.Peer
Sections
Available Peer Implementations
Examples
Summary
Types
option/0
Callbacks
leader?/1
start_link/1
Functions
leader?/2
Oban.Plugin
Sections
Example
Summary
Types
option/0
Callbacks
start_link/1
validate/1
Oban.Registry
Summary
Types
key/0
role/0
value/0
Functions
config/1
via/3
whereis/2
Oban.Repo
Summary
Functions
aggregate/4
aggregate/5
all/3
checkout/3
config/1
delete/3
delete_all/3
insert/3
insert_all/4
one/3
query/4
stream/3
to_sql/3
transaction/3
update/3
update_all/4
Notifiers
Oban.Notifiers.PG
Sections
Usage
Implementation Notes
Summary
Functions
child_spec/1
Oban.Notifiers.Postgres
Sections
Usage
Caveats
Summary
Functions
listen/2
start_link/1
unlisten/2
Peers
Oban.Peers.Global
Sections
Usage
Summary
Functions
child_spec/1
Oban.Peers.Postgres
Sections
Usage
Summary
Functions
child_spec/1
Exceptions
Oban.CrashError
Oban.PerformError
Oban.TimeoutError
Settings
View Source
Oban.CrashError
exception
(Oban v2.13.0)
Wraps unhandled exits and throws that occur during job execution.
×