DAL v0.3.0 DAL.Behaviour behaviour
Useful for defining mocks with Mox
Link to this section Summary
Link to this section Callbacks
Link to this callback
aggregate(queryable, aggregate, field, opts)
aggregate(queryable, aggregate, field, opts)
aggregate(
queryable :: Ecto.Query.t(),
aggregate :: :avg | :count | :max | :min | :sum,
field :: atom(),
opts :: Keyword.t()
) :: [Ecto.Schema.t()] | no_return()
aggregate( queryable :: Ecto.Query.t(), aggregate :: :avg | :count | :max | :min | :sum, field :: atom(), opts :: Keyword.t() ) :: [Ecto.Schema.t()] | no_return()
Link to this callback
all(queryable, opts)
all(queryable, opts)
all(queryable :: Ecto.Query.t(), opts :: Keyword.t()) ::
[Ecto.Schema.t()] | no_return()
all(queryable :: Ecto.Query.t(), opts :: Keyword.t()) :: [Ecto.Schema.t()] | no_return()
Link to this callback
all_ids(queryable, id_list, opts)
all_ids(queryable, id_list, opts)
all_ids(queryable :: Ecto.Query.t(), id_list :: [term()], opts :: Keyword.t()) ::
[Ecto.Schema.t()] | no_return()
all_ids(queryable :: Ecto.Query.t(), id_list :: [term()], opts :: Keyword.t()) :: [Ecto.Schema.t()] | no_return()
Link to this callback
delete(struct_or_changeset, opts)
delete(struct_or_changeset, opts)
delete(
struct_or_changeset :: Ecto.Schema.t() | Ecto.Changeset.t(),
opts :: Keyword.t()
) :: {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
delete( struct_or_changeset :: Ecto.Schema.t() | Ecto.Changeset.t(), opts :: Keyword.t() ) :: {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
Link to this callback
delete!(struct_or_changeset, opts)
delete!(struct_or_changeset, opts)
delete!(
struct_or_changeset :: Ecto.Schema.t() | Ecto.Changeset.t(),
opts :: Keyword.t()
) :: Ecto.Schema.t() | no_return()
delete!( struct_or_changeset :: Ecto.Schema.t() | Ecto.Changeset.t(), opts :: Keyword.t() ) :: Ecto.Schema.t() | no_return()
Link to this callback
delete_all(queryable, opts)
delete_all(queryable, opts)
delete_all(queryable :: Ecto.Queryable.t(), opts :: Keyword.t()) ::
{:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
delete_all(queryable :: Ecto.Queryable.t(), opts :: Keyword.t()) :: {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
Link to this callback
get(queryable, id, opts)
get(queryable, id, opts)
get(queryable :: Ecto.Queryable.t(), id :: term(), opts :: Keyword.t()) ::
Ecto.Schema.t() | nil | no_return()
get(queryable :: Ecto.Queryable.t(), id :: term(), opts :: Keyword.t()) :: Ecto.Schema.t() | nil | no_return()
Link to this callback
get!(queryable, id, opts)
get!(queryable, id, opts)
get!(queryable :: Ecto.Queryable.t(), id :: term(), opts :: Keyword.t()) ::
Ecto.Schema.t() | nil | no_return()
get!(queryable :: Ecto.Queryable.t(), id :: term(), opts :: Keyword.t()) :: Ecto.Schema.t() | nil | no_return()
Link to this callback
get_by(queryable, clauses, opts)
get_by(queryable, clauses, opts)
get_by(
queryable :: Ecto.Queryable.t(),
clauses :: Keyword.t() | map(),
opts :: Keyword.t()
) :: Ecto.Schema.t() | nil | no_return()
get_by( queryable :: Ecto.Queryable.t(), clauses :: Keyword.t() | map(), opts :: Keyword.t() ) :: Ecto.Schema.t() | nil | no_return()
Link to this callback
get_by!(queryable, clauses, opts)
get_by!(queryable, clauses, opts)
get_by!(
queryable :: Ecto.Queryable.t(),
clauses :: Keyword.t() | map(),
opts :: Keyword.t()
) :: Ecto.Schema.t() | nil | no_return()
get_by!( queryable :: Ecto.Queryable.t(), clauses :: Keyword.t() | map(), opts :: Keyword.t() ) :: Ecto.Schema.t() | nil | no_return()
Link to this callback
insert(struct_or_changeset, opts)
insert(struct_or_changeset, opts)
insert(
struct_or_changeset :: Ecto.Schema.t() | Ecto.Changeset.t(),
opts :: Keyword.t()
) :: {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
insert( struct_or_changeset :: Ecto.Schema.t() | Ecto.Changeset.t(), opts :: Keyword.t() ) :: {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
Link to this callback
insert!(struct_or_changeset, opts)
insert!(struct_or_changeset, opts)
insert!(
struct_or_changeset :: Ecto.Schema.t() | Ecto.Changeset.t(),
opts :: Keyword.t()
) :: Ecto.Schema.t() | no_return()
insert!( struct_or_changeset :: Ecto.Schema.t() | Ecto.Changeset.t(), opts :: Keyword.t() ) :: Ecto.Schema.t() | no_return()
Link to this callback
insert_all(schema_or_source, entries, opts)
insert_all(schema_or_source, entries, opts)
insert_all(
schema_or_source :: binary() | {binary(), Ecto.Schema.t()} | Ecto.Schema.t(),
entries :: [map() | Keyword.t()],
opts :: Keyword.t()
) :: {integer(), nil | [term()]} | no_return()
insert_all( schema_or_source :: binary() | {binary(), Ecto.Schema.t()} | Ecto.Schema.t(), entries :: [map() | Keyword.t()], opts :: Keyword.t() ) :: {integer(), nil | [term()]} | no_return()
Link to this callback
insert_bulk(changesets, list)
insert_bulk(changesets, list)
insert_bulk(changesets :: [Ecto.Changeset.t()], [{:opts, list()}]) ::
{:ok, [map()]} | {:error, Ecto.Changeset.t()}
insert_bulk(changesets :: [Ecto.Changeset.t()], [{:opts, list()}]) :: {:ok, [map()]} | {:error, Ecto.Changeset.t()}
Link to this callback
insert_or_update(struct_or_changeset, opts)
insert_or_update(struct_or_changeset, opts)
insert_or_update(
struct_or_changeset :: Ecto.Schema.t() | Ecto.Changeset.t(),
opts :: Keyword.t()
) :: {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
insert_or_update( struct_or_changeset :: Ecto.Schema.t() | Ecto.Changeset.t(), opts :: Keyword.t() ) :: {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
Link to this callback
insert_or_update!(struct_or_changeset, opts)
insert_or_update!(struct_or_changeset, opts)
insert_or_update!(
struct_or_changeset :: Ecto.Schema.t() | Ecto.Changeset.t(),
opts :: Keyword.t()
) :: {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
insert_or_update!( struct_or_changeset :: Ecto.Schema.t() | Ecto.Changeset.t(), opts :: Keyword.t() ) :: {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
Link to this callback
one(queryable, opts)
one(queryable, opts)
one(queryable :: Ecto.Query.t(), opts :: Keyword.t()) ::
Ecto.Schema.t() | nil | no_return()
one(queryable :: Ecto.Query.t(), opts :: Keyword.t()) :: Ecto.Schema.t() | nil | no_return()
Link to this callback
stream(queryable, opts)
stream(queryable, opts)
stream(queryable :: Ecto.Query.t(), opts :: Keyword.t()) :: Enum.t()
stream(queryable :: Ecto.Query.t(), opts :: Keyword.t()) :: Enum.t()
Link to this callback
transaction(arg0)
transaction(arg0)
transaction(Multi.t() | Ecto.Query.t()) ::
{:ok, any()}
| {:error, any()}
| {:error, Ecto.Multi.name(), any(),
%{optional(Ecto.Multi.name()) => any()}}
transaction(Multi.t() | Ecto.Query.t()) :: {:ok, any()} | {:error, any()} | {:error, Ecto.Multi.name(), any(), %{optional(Ecto.Multi.name()) => any()}}
Link to this callback
update(struct_or_changeset, opts)
update(struct_or_changeset, opts)
update(
struct_or_changeset :: Ecto.Schema.t() | Ecto.Changeset.t(),
opts :: Keyword.t()
) :: {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
update( struct_or_changeset :: Ecto.Schema.t() | Ecto.Changeset.t(), opts :: Keyword.t() ) :: {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
Link to this callback
update!(struct_or_changeset, opts)
update!(struct_or_changeset, opts)
update!(
struct_or_changeset :: Ecto.Schema.t() | Ecto.Changeset.t(),
opts :: Keyword.t()
) :: Ecto.Schema.t() | no_return()
update!( struct_or_changeset :: Ecto.Schema.t() | Ecto.Changeset.t(), opts :: Keyword.t() ) :: Ecto.Schema.t() | no_return()