FatEcto is an Elixir package designed to make your life easier when working with Ecto. It simplifies query building, filtering, sorting, pagination, and data sanitization—so you can focus on what truly matters: building amazing applications. With FatEcto, writing complex queries becomes effortless, flexible, and powerful! 💪
Getting started is simple! Add fat_ecto to your list of dependencies in mix.exs:
def deps do
[
# Check https://hexdocs.pm/fat_ecto for the latest version
{:fat_ecto, "~> 1.0.0"}
]
endThen, run mix deps.get to install the package.
Tired of writing repetitive query filters? The Whereable module lets you dynamically filter records using flexible conditions passed from your web or mobile clients—with little to no effort! And the best part? You stay in control. 🚀
defmodule FatEcto.FatHospitalFilter do
use FatEcto.FatQuery.Whereable,
filterable_fields: %{
"id" => ["$EQUAL", "$NOT_EQUAL"]
},
overrideable_fields: ["name", "phone"],
ignoreable_fields_values: %{
"name" => ["%%", "", [], nil],
"phone" => ["%%", "", [], nil]
}
import Ecto.Query
# You can implement override_whereable for your custom filters
def override_whereable(dynamics, "name", "$ILIKE", value) do
dynamics and dynamic([r], ilike(fragment("(?)::TEXT", r.name), ^value))
end
def override_whereable(dynamics, _, _, _), do: dynamics
endHere are some practical examples of how to use FatEcto.FatHospitalFilter to dynamically build queries:
# Filter hospitals with ID equal to 1
params = %{"id" => %{"$EQUAL" => 1}}
dynamics = FatEcto.FatHospitalFilter.build(params)
# Use the dynamics in a query
import Ecto.Query
query = where(FatEcto.FatHospital, ^dynamics)
# Resulting query:
# from(h in FatEcto.FatHospital, where: h.id == 1)# Filter hospitals with names containing "St. Mary"
params = %{"name" => %{"$ILIKE" => "%St. Mary%"}}
dynamics = FatEcto.FatHospitalFilter.build(params)
# Use the dynamics in a query
import Ecto.Query
query = where(FatEcto.FatHospital, ^dynamics)
# Resulting query:
# from(h in FatEcto.FatHospital, where: ilike(fragment("(?)::TEXT", h.name), ^"%St. Mary%"))# Filter hospitals with ID not equal to 2 AND name containing "General"
params = %{
"id" => %{"$NOT_EQUAL" => 2},
"name" => %{"$ILIKE" => "%General%"}
}
dynamics = FatEcto.FatHospitalFilter.build(params)
# Use the dynamics in a query
import Ecto.Query
query = where(FatEcto.FatHospital, ^dynamics)
# Resulting query:
# from(h in FatEcto.FatHospital, where: h.id != 2 and ilike(fragment("(?)::TEXT", h.name), ^"%General%"))# Filter hospitals with a name, but ignore empty or invalid values
params = %{"name" => %{"$ILIKE" => "%%"}} # Empty value is ignored
dynamics = FatEcto.FatHospitalFilter.build(params)
# Use the dynamics in a query
import Ecto.Query
query = where(FatEcto.FatHospital, ^dynamics)
# Resulting query:
# from(h in FatEcto.FatHospital) # No filtering applied for nameSorting should be simple—and with Sortable, it is! Your frontend can send sorting parameters, and FatEcto will seamlessly generate the right sorting queries, allowing you to build powerful, customizable sorting logic without breaking a sweat. 😎
defmodule Fat.SortQuery do
import Ecto.Query
use FatEcto.FatQuery.Sortable,
sortable_fields: %{"id" => "$ASC", "name" => ["$ASC", "$DESC"]},
overrideable_fields: ["custom_field"]
@impl true
def override_sortable(query, field, operator) do
case {field, operator} do
{"custom_field", "$ASC"} ->
from(q in query, order_by: [asc: fragment("?::jsonb->>'custom_field'", q)])
_ ->
query
end
end
endNo more hassle with pagination! FatPaginator helps you paginate Ecto queries efficiently, keeping your APIs snappy and responsive.
defmodule Fat.MyPaginator do
use FatEcto.FatPaginator, repo: Fat.Repo
# Add custom pagination functions here
endMessy data? Not anymore! DataSanitizer helps you sanitize records and transform them into structured, clean views effortlessly. Keep your data tidy and consistent. 🎯
defmodule Fat.MySanitizer do
use FatEcto.DataSanitizer
# Define your custom sanitization functions here
endFatEcto also comes with a set of handy utility functions to streamline your workflow:
# Check if a map contains all required keys
FatUtils.Map.has_all_keys?(%{a: 1, b: 2}, [:a, :b])
# Ensure a map contains only allowed keys
FatUtils.Map.contain_only_allowed_keys?(%{a: 1, c: 3}, [:a, :b])We love contributions! If you’d like to improve FatEcto, submit an issue or pull request. Let’s build something amazing together! 🔥
FatEcto is released under the MIT License.
📖 See the full documentation at HexDocs for more details.