Oban.start_queue
You're seeing just the function
start_queue
, go back to Oban module for more information.
Specs
start_queue(name(), opts :: [queue_option()]) :: :ok
Start a new supervised queue.
By default this starts a new supervised queue across all nodes running Oban on the same database
and prefix. You can pass the option local_only: true
if you prefer to start the queue only on
the local node.
Options
:queue
- a string or atom specifying the queue to start, required:limit
- set the concurrency limit, required:local_only
- whether the queue will be started only on the local node, default:false
Example
Start the :priority
queue with a concurrency limit of 10 across the connected nodes.
Oban.start_queue(queue: :priority, limit: 10)
:ok
Start the :media
queue with a concurrency limit of 5 only on the local node.
Oban.start_queue(queue: :media, limit: 5, local_only: true)
:ok