AntlUtilsEcto.Queryable behaviour (antl_utils_ecto v2.13.2)

View Source

Superpower your schemas.

Summary

Callbacks

filter(t, keyword)
include(t, list)
order_by(t, arg2)
paginate(t, pos_integer, pos_integer)
queryable()
search(t, binary)
select_fields(t, list)

Functions

filter_by_field(queryable, arg)
filter_by_field(queryable, arg, metadata)
order_by(queryable, order_bys)
paginate(queryable, page_size, page_number)
search_by_field(dynamic, arg)
search_by_field(dynamic, arg, metadata)
select_fields(queryable, fields)

Callbacks

filter(t, keyword)

@callback filter(
  Ecto.Queryable.t(),
  keyword()
) :: Ecto.Queryable.t()

include(t, list)

@callback include(Ecto.Queryable.t(), list()) :: Ecto.Queryable.t()

order_by(t, arg2)

@callback order_by(Ecto.Queryable.t(), list() | keyword()) :: Ecto.Queryable.t()

paginate(t, pos_integer, pos_integer)

@callback paginate(Ecto.Queryable.t(), pos_integer(), pos_integer()) :: Ecto.Queryable.t()

queryable()

@callback queryable() :: Ecto.Queryable.t()

search(t, binary)

@callback search(Ecto.Queryable.t(), binary()) :: Ecto.Queryable.t()

select_fields(t, list)

@callback select_fields(Ecto.Queryable.t(), list()) :: Ecto.Queryable.t()

Functions

filter_by_field(queryable, arg)

filter_by_field(queryable, arg, metadata)

@spec filter_by_field(any(), {any(), any()}, keyword()) :: Ecto.Query.t()

order_by(queryable, order_bys)

@spec order_by(Ecto.Queryable.t(), list()) :: Ecto.Queryable.t()

paginate(queryable, page_size, page_number)

@spec paginate(any(), pos_integer(), pos_integer()) :: Ecto.Query.t()

search_by_field(dynamic, arg)

@spec search_by_field(
  Ecto.Query.DynamicExpr.t(),
  {any(), binary()}
) :: Ecto.Query.DynamicExpr.t()

search_by_field(dynamic, arg, metadata)

@spec search_by_field(Ecto.Query.DynamicExpr.t(), {any(), binary()}, any()) ::
  Ecto.Query.DynamicExpr.t()

select_fields(queryable, fields)

@spec select_fields(Ecto.Queryable.t(), nil | list()) :: Ecto.Queryable.t()