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
Top
Sections
Testing
Error Handling
Instrumentation and Logging
Isolation
Summary
Types
drain_option/0
drain_result/0
job_changeset/0
name/0
option/0
queue_name/0
queue_option/0
queue_state/0
Functions
cancel_job/2
check_queue/2
child_spec/1
config/1
drain_queue/2
insert/2
insert/4
insert!/2
insert_all/2
insert_all/4
pause_queue/2
resume_queue/2
retry_job/2
scale_queue/2
start_link/1
start_queue/2
stop_queue/2
whereis/1
Oban.Job
Top
Summary
Types
args/0
errors/0
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
Oban.Migrations
Top
Sections
Usage
Isolation with Prefixes
Summary
Functions
down/1
up/1
Oban.Telemetry
Top
Sections
Default Logger
Examples
Summary
Functions
attach_default_logger/1
span/3
Oban.Testing
Top
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
Oban.Worker
Top
Sections
Defining Workers
Enqueuing Jobs
Customizing Backoff
Limiting Execution Time
Summary
Types
result/0
t/0
Functions
from_string/1
to_string/1
Callbacks
backoff/1
new/2
perform/1
timeout/1
Plugins
Oban.Plugins.Cron
Top
Sections
Using the Plugin
Options
Instrumenting with Telemetry
Summary
Types
cron_input/0
cron_opt/0
option/0
Functions
child_spec/1
start_link/1
Oban.Plugins.Pruner
Top
Sections
Using the Plugin
Options
Instrumenting with Telemetry
Summary
Types
option/0
Functions
child_spec/1
Oban.Plugins.Stager
Top
Sections
Options
Instrumenting with Telemetry
Summary
Types
option/0
Functions
child_spec/1
start_link/1
Extending
Oban.Config
Top
Summary
Types
option/0
t/0
Oban.Notifier
Top
Sections
Channels
Caveats
Examples
Summary
Types
channel/0
option/0
Functions
child_spec/1
listen/2
notify/3
Oban.Registry
Top
Summary
Types
key/0
role/0
value/0
Functions
config/1
via/3
whereis/2
Oban.Repo
Top
Summary
Types
config/0
Functions
all/3
checkout/3
config/1
delete/3
delete_all/3
insert/3
insert_all/4
one/3
query/4
to_sql/3
transaction/3
update/3
update_all/4
Exceptions
Oban.CrashError
Top
Oban.PerformError
Top
Oban.TimeoutError
Top
Oban.CrashError
exception
(Oban v2.4.0)
View Source
Wraps unhandled exits and throws that occur during job execution.
Keyboard Shortcuts
×
c
Toggle sidebar
n
Toggle night mode
/
or
s
Focus search bar
g
Go to a HexDocs package
?
Bring up this help dialog
Go to a HexDocs package
×