This library will help you easily add searching to your Phoenix/Ecto application, without any additional dependencies.
There are advanced searching solutions around, like ElasticSearch or Algolia. Seeker will do the job for many Phoenix/Ecto apps, without the need to run additional infrastructure or work in a different language.
Add seeker to your list of dependencies in mix.exs:
def deps do
[
{:seeker, "~> 0.1.0"}
]
endAdd a MyApp.Seeker module as the following example:
# lib/my_app/seeker.ex
defmodule MyApp.Seeker do
use Seeker,
otp_app: :my_app,
repo: MyApp.Repo
endAssuming a params map with the following structure:
%{
q: %{
first_name_eq: "Foo",
email_end: "gmail.com",
status_in: ["premium", "plus"]
},
s: "last_name+asc"
}Please check supported predicates.
Then, use all/2 function in the controller like this:
defmodule MyAppWeb.UserController do
use MyAppWeb, :controller
alias MyApp.Seeker
alias MyApp.Accounts.User
def index(conn, params) do
users = User |> Seeker.all(params)
render(conn, :index, users: users)
end
endUse query/2 function when performing queries after using Seeker or
using pagination. Like this:
defmodule MyAppWeb.UserController do
use MyAppWeb, :controller
alias MyApp.Accounts.User
alias MyApp.{Seeker, Repo}
def index(conn, params) do
page =
User
|> Seeker.query(params)
|> Repo.paginate(params)
render(conn, :index, page: page)
end
endDocumentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/seeker.