Oban.pause_queue

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

pause_queue(name \\ __MODULE__, opts)

View Source (since 0.2.0)

Specs

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

Pause a running queue, preventing it from executing any new jobs. All running jobs will remain running until they are finished.

When shutdown begins all queues are paused.

Options

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

Example

Pause the default queue:

Oban.pause_queue(queue: :default)
:ok

Pause the default queue, but only on the local node:

Oban.pause_queue(queue: :default, local_only: true)
:ok