Rummage.Ecto v2.0.0 API Reference

Rummage.Ecto is a light weight, but powerful framework that can be used to alter Ecto queries with Search, Sort and Paginate operations.

This module encapsulates all the Rummage's runtime configurations that can be set in the config.exs file.

Rummage.Ecto.CustomHook.KeysetPaginate is an example of a Custom Hook that comes with Rummage.Ecto.

Rummage.Ecto.CustomHook.SimpleSearch is an example of a Custom Hook that comes with Rummage.Ecto.

Rummage.Ecto.CustomHook.SimpleSort is the default sort hook that comes with Rummage.Ecto.

This module defines a behaviour that Rummage.Ecto.Hooks have to follow.

Rummage.Ecto.Hook.Paginate is the default pagination hook that comes with Rummage.Ecto.

Rummage.Ecto.Hook.Search is the default search hook that comes with Rummage.Ecto.

Rummage.Ecto.Hook.Sort is the default sort hook that comes with Rummage.Ecto.

This module is meant to be used by a module (typically an Ecto.Schema).

Usage

Usage

Usage

Usage

Rummage.Ecto.Services.BuildSearchQuery is a service module which serves the default search hook, Rummage.Ecto.Hook.Search that comes shipped with Rummage.Ecto.