Turbo is a very rich ecto component,including search sort and paginate. Inspiration by ruby ransack and learn from rummage_ecto

Phoenix support turbo_html, check this repos.

• Getting started
• Examples
• Search Matchers
• Features
• Contributing
• Make a pull request
• License
• Credits

The package can be installed by adding :turbo_ecto to your list of dependencies in mix.exs:

def deps do
  [
    {:turbo_ecto, "~> 1.0.1"}
  ]
end

Add the Repo of your app and the desired per_page to the :turbo_ecto configuration in config.exs:

config :turbo_ecto, Turbo.Ecto,
  repo: MyApp.Repo,
  per_page: 10

You can also define other configurations with entry_name and pagenate_name in config.exs.

Category Table Structure:

Post Table Structure:

iex> params = %{
      "q" => %{"name_and_category_name_like" => "elixir"},
      "s" => "inserted_at+asc",
      "page" = 0,
      "per_page" => 20
     }

iex> Turbo.Ecto.turbo(Turbo.Ecto.Schemas.Post, params)
%{
  datas: [%Turbo.Ecto.Schemas.Post{}],
  paginate: %{
    current_page: 10,
    next_page: 11,
    per_page: 20,
    prev_page: 9,
    total_count: 100,
    total_pages: 20
  }
}

• 1 queryable: receives a schema object or an Ecto.Query.t() object

• 2 params: supports 4 parameters.

  • q or filter to receive pattern matching information, e.g. params = %{"q" ⇒ %{"name_like" ⇒ "elixir"}} or params = %{"filter" ⇒ %{"name_like" ⇒ "elixir"}
  • s or sort Receive sort information. e.g. params = %{"sort" ⇒ "position+asc"} or params = %{"s" ⇒ "inserted_at+desc"}
  • page Receive query page number. e.g. params = %{"page" ⇒ 1}
  • per_page Receive the number of pages. e.g. params = %{"per_page" ⇒ 20}

• 3 opts: currently receives the following information:

  • paginate_name: sets the pagination key value of the returned result
  • entry_name: sets the key value of the returned result object
  • prefix: table prefix
  • with_paginate: whether to include pagination information, default true
  • callback: callback processing for queryable

Returns an Ecto.Query.t() object

More example pls move: docs

List of all possible search_types:

Bug report or pull request are welcome.

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Please write unit test with your code if necessary.

Copyright (c) 2018 Zven Wang

The library is available as open source under the terms of the MIT License.

• ecto - Very great API.
• ransack - Initial inspiration of this project.
• rummage_ecto - Similar implementation.