Rummage.Ecto v2.0.0 Rummage.Ecto.Hook.CustomSearch View Source

Link to this section Summary

Functions

Callback implementation for Rummage.Ecto.Hook.format_params/3.

Link to this section Functions

Link to this function

format_params(queryable, params, opts)

View Source

Specs

format_params(Ecto.Query.t(), map(), keyword()) :: map()
format_params(Ecto.Query.t(), map(), keyword()) :: map()

Callback implementation for Rummage.Ecto.Hook.format_params/3.

This function ensures that params for each field have keys assoc, search_type and search_expr which are essential for running this hook module.

Examples

iex> alias Rummage.Ecto.Hook.CustomSearch
iex> Search.format_params(Parent, %{field: %{}}, [])
%{field: %{assoc: [], search_expr: :where, search_type: :eq}}

Specs

run(Ecto.Query.t(), map()) :: Ecto.Query.t()
run(Ecto.Query.t(), map()) :: Ecto.Query.t()