Skip to content

Commit

Permalink
Document use of false to disable plugins or queues
Browse files Browse the repository at this point in the history
  • Loading branch information
sorentwo committed Aug 30, 2024
1 parent 861dfa5 commit 74d8961
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion lib/oban.ex
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,8 @@ defmodule Oban do
Defaults to the `Postgres` peer.
* `:plugins` — a list or modules or module/option tuples that are started as children of an Oban
supervisor. Any supervisable module is a valid plugin, i.e. a `GenServer` or an `Agent`.
supervisor. Any supervisable module is a valid plugin, i.e. a `GenServer` or an `Agent`. May
also be set to `false` to disable plugins _and_ disable leadership.
* `:prefix` — the query prefix, or schema, to use for inserting and executing jobs. An
`oban_jobs` table must exist within the prefix. See the "Prefix Support" section in the module
Expand All @@ -343,6 +344,8 @@ defmodule Oban do
Queues accept additional override options to customize their behavior, e.g. by setting
`paused` or `dispatch_cooldown` for a specific queue.
Using an empty list or `false` prevents any queues from starting on init.
* `:testing` — a mode that controls how an instance is configured for testing. When set to
`:inline` or `:manual` queues, peers, and plugins are automatically disabled. Defaults to
`:disabled`, no test mode.
Expand Down

0 comments on commit 74d8961

Please sign in to comment.