Oban.stop_queue

You're seeing just the function stop_queue, go back to Oban module for more information.
Link to this function

stop_queue(name \\ __MODULE__, opts)

View Source (since 0.12.0)

Specs

stop_queue(name(), opts :: [queue_option()]) :: :ok

Shutdown a queue's supervision tree and stop running jobs for that queue.

By default this action will occur across all the running nodes. Still, if you prefer to stop the queue's supervision tree and stop running jobs for that queue only on the local node, you can pass the option: local_only: true

The shutdown process pauses the queue first and allows current jobs to exit gracefully, provided they finish within the shutdown limit.

Options

  • :queue - a string or atom specifying the queue to stop, required
  • :local_only - whether the queue will be stopped only on the local node, default: false

Example

Oban.stop_queue(queue: :default)
:ok

Oban.stop_queue(queue: :media, local_only: true)
:ok