Oban.Repo (Oban v2.4.0) View Source

Wrappers around Ecto.Repo callbacks.

These functions should be used when working with an Ecto repo inside a plugin. These functions will resolve the correct repo instance, and set the schema prefix and the log level, according to the Oban configuration.

Link to this section Summary

Types

config()

Functions

all(conf, queryable, opts \\ [])

Wraps Ecto.Repo.all/2.

checkout(conf, function, opts \\ [])

Wraps Ecto.Repo.checkout/2.

config(conf)

Wraps Ecto.Repo.config/0.

delete(conf, struct_or_changeset, opts \\ [])

Wraps Ecto.Repo.delete/2.

delete_all(conf, queryable, opts \\ [])

Wraps Ecto.Repo.delete_all/2.

insert(conf, struct_or_changeset, opts \\ [])

Wraps Ecto.Repo.insert/2.

insert_all(conf, schema_or_source, entries, opts \\ [])

Wraps Ecto.Repo.insert_all/3.

one(conf, queryable, opts \\ [])

Wraps Ecto.Repo.one/2.

query(conf, sql, params \\ [], opts \\ [])

Wraps Ecto.Adapters.SQL.Repo.query/4.

to_sql(conf, kind, queryable)

Wraps Ecto.Adapters.SQL.Repo.to_sql/2.

transaction(conf, fun_or_multi, opts \\ [])

Wraps Ecto.Repo.transaction/2.

update(conf, changeset, opts \\ [])

Wraps Ecto.Repo.update/2.

update_all(conf, queryable, updates, opts \\ [])

Wraps Ecto.Repo.update_all/3.

Link to this section Types

config()

Specs

config() :: %{
  :repo => module(),
  optional(:get_dynamic_repo) => (() -> pid() | atom()),
  optional(:log) => false | Logger.level(),
  optional(:prefix) => binary(),
  optional(any()) => any()
}

Link to this section Functions

all(conf, queryable, opts \\ [])

(since 2.2.0)

Specs

all(config(), Ecto.Queryable.t(), Keyword.t()) :: [Ecto.Schema.t()]

Wraps Ecto.Repo.all/2.

checkout(conf, function, opts \\ [])

(since 2.2.0)

Specs

checkout(config(), (() -> result), Keyword.t()) :: result when result: var

Wraps Ecto.Repo.checkout/2.

config(conf)

(since 2.2.0)

Specs

config(config()) :: Keyword.t()

Wraps Ecto.Repo.config/0.

delete(conf, struct_or_changeset, opts \\ [])

(since 2.4.0)

Specs

delete(
  config(),
  struct_or_changeset :: Ecto.Schema.t() | Ecto.Changeset.t(),
  opts :: Keyword.t()
) :: {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}

Wraps Ecto.Repo.delete/2.

delete_all(conf, queryable, opts \\ [])

(since 2.2.0)

Specs

delete_all(config(), Ecto.Queryable.t(), Keyword.t()) ::
  {integer(), nil | [term()]}

Wraps Ecto.Repo.delete_all/2.

insert(conf, struct_or_changeset, opts \\ [])

(since 2.2.0)

Specs

insert(config(), Ecto.Schema.t() | Ecto.Changeset.t(), Keyword.t()) ::
  {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}

Wraps Ecto.Repo.insert/2.

insert_all(conf, schema_or_source, entries, opts \\ [])

(since 2.2.0)

Specs

insert_all(
  config(),
  binary() | {binary(), module()} | module(),
  [map() | [{atom(), term() | Ecto.Query.t()}]],
  Keyword.t()
) :: {integer(), nil | [term()]}

Wraps Ecto.Repo.insert_all/3.

one(conf, queryable, opts \\ [])

(since 2.2.0)

Specs

one(config(), Ecto.Queryable.t(), Keyword.t()) :: Ecto.Schema.t() | nil

Wraps Ecto.Repo.one/2.

query(conf, sql, params \\ [], opts \\ [])

(since 2.2.0)

Specs

query(config(), String.t(), [term()], Keyword.t()) ::
  {:ok,
   %{
     :rows => nil | [[term()] | binary()],
     :num_rows => non_neg_integer(),
     optional(atom()) => any()
   }}
  | {:error, Exception.t()}

Wraps Ecto.Adapters.SQL.Repo.query/4.

to_sql(conf, kind, queryable)

(since 2.2.0)

Specs

to_sql(config(), :all | :update_all | :delete_all, Ecto.Queryable.t()) ::
  {String.t(), [term()]}

Wraps Ecto.Adapters.SQL.Repo.to_sql/2.

transaction(conf, fun_or_multi, opts \\ [])

(since 2.2.0)

Specs

transaction(config(), (... -> any()) | Ecto.Multi.t(), opts :: Keyword.t()) ::
  {:ok, any()}
  | {:error, any()}
  | {:error, Ecto.Multi.name(), any(), %{required(Ecto.Multi.name()) => any()}}

Wraps Ecto.Repo.transaction/2.

update(conf, changeset, opts \\ [])

(since 2.2.0)

Specs

update(config(), Ecto.Changeset.t(), Keyword.t()) ::
  {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}

Wraps Ecto.Repo.update/2.

update_all(conf, queryable, updates, opts \\ [])

(since 2.2.0)

Specs

update_all(config(), Ecto.Queryable.t(), Keyword.t(), Keyword.t()) ::
  {integer(), nil | [term()]}

Wraps Ecto.Repo.update_all/3.