MatijaL

MatijaL

Best practices when writing context functions with DB queries

Hello,

I would like to hear your opinion on writing controller/context functions with DB queries.

Let’s say that we have an hypothetical app where people can create projects. We have a show project page but we also have a page where all projects are listed, then in the user area, we have places where we want to list only user projects or a place with only active projects, or 5 latest projects etc. What I mean, on different places inside our app, we need to fetch different projects based on some conditions. How do you approach writing queries in this situation?

Do you write a different function for each of those?

def get_user_projects(user) do
  query = from p in Project, where: p.user_id == ^user.id
  Repo.all(query)
end

def get_user_active_projects(user) do
  query = from p in Project, where: p.user_id == ^user.id and p.status == "active"
  Repo.all(query)
end

def get_user_latest_projects(user) do
  query = from p in Project, where: p.user_id == ^user.id, limit: 5
  Repo.all(query)
end

Or do you create more generic functions which creates a query based on opts

def list_user_campaigns(user, opts \\ []) do
    status = Keyword.get(opts, :status)
    limit = Keyword.get(opts, :limit)

    Campaign
    |> where(user_id: ^user.id)
    |> maybe_add_query_status(status)
    |> maybe_add_query_limit(limit)
    |> Repo.all()
end

defp maybe_add_query_status(query, nil), do: query
defp maybe_add_query_status(query, status), do: where(status: ^status)

defp maybe_add_query_limit(query, nil), do: query
defp maybe_add_query_limit(query, limit), do: limit(query, ^limit)

Or do you maybe take some completely different approach?

Most Liked

dimitarvp

dimitarvp

I’ve seen both and both are fine. Go for what feels better for you.

sbuttgereit

sbuttgereit

I find that if I’m accessing the same basic data with some frequency, but using a lot of different flavors of essentially the same query, I’ll use your second, “generic query” approach. I do this because, for me, it’s easier to mentally deal with a single function with options that I’m using frequently than it is to try to remember many specific function names with few options; indeed I might have trouble remembering if I’ve covered a specific use case previously at all. I also find that the more generic approach is just more flexible because I may be able to mix/match options in ways I didn’t originally intend (this usually works out OK, there can be downsides). If I forget the options, finding my documentation about what’s available and what to worry about is also easier with a generic function/many options.

Now I do use the more specific function method, too, if I know that my calling use cases are narrower and not going to be generally useful. In that case I find the balance shifts to having more natural language like code that specifically names the purpose that the functions provides.

As previously pointed out… it’s really personal or team preference about how/when to the use either of the two approaches. Just don’t let it get you into a bikeshedding trap :slight_smile: .

Where Next?

Popular in Questions Top

Tee
can someone please explain to me how Enum.reduce works with maps
New
lessless
I believe there are people here who are dealing with CSV files import on the daily basis, and since Excel is a really popular tool there ...
New
ycv005
I have followed this StackOverflow post to install the specific version of Erlang. And When I am running mix ecto.setup then getting fol...
New
freewebwithme
Using vs code and installed ElixirLS: support and debugger. And I got an error popped up on start up says Failed to run ‘elixir’ comma...
New
aadeshere1
I have a another noob question about loop. Since elixir is immutable, while loop is not directly possible. total = 10 while total != 0 ...
New
mathew4509
I have a list say x = ["23gh", "56kh", "97mh"] I would like to pass each element to Val in each iteration. Say, in iteration 1 -------...
New
WestKeys
Currently suffering from paralysis by [HTTP client] analysis. This is rather unusual in Elixirland as there tends to be consensus on the ...
New
Patoshizzle
After calling mix ecto.create I get this error: 17:00:32.162 [error] GenServer #PID<0.412.0> terminating ** (Postgrex.Error) FATAL...
New
jay1
Why is it that the mnesia database isn’t the most preferred database for use in Elixir/Phoenix?
New
idi527
I’ve been re-reading swift book again and noticed that multiline strings there don’t have a trailing line break, unlike in elixir iex(2)...
New

Other popular topics Top

yurko
Here are few pieces of (common) Linux knowledge that we use for reasonably small one server apps. We use Ubuntu but this should work for ...
New
Tee
can someone please explain to me how Enum.reduce works with maps
New
chrismccord
This release brings a number of exciting features, including integration with the new Phoenix LiveDashboard and Phoenix LiveView. There h...
New
script
If I have a string “1000 cfu/ml” . I want to remove the characters and / and space . So the string is like this "1000" What is the ...
New
vac
Hi, I'm quite new in Elixir and I'm trying to format a string to a PEM format. I have the certificate value like MIIDBTCCAe2...... and ...
New
freewebwithme
Using vs code and installed ElixirLS: support and debugger. And I got an error popped up on start up says Failed to run ‘elixir’ comma...
New
chensan
I have a User schema with a :from_id field set to type :string: defmodule TweetBot.Repo.Migrations.CreateUsers do use Ecto.Migration ...
New
msaraiva
Surface is an experimental library built on top of Phoenix LiveView and its new LiveComponent API that aims to provide a more declarative...
564 42633 214
New
ovidiubadita
Hey all, I discovered Elixir and I love it. I always wanted to learn a functional programming and I intended to go for Haskell, but afte...
New
baxterw3b
Hi guys, i’m new in the Elixir world, and i have to say, that i love it! i’m having some problem to understand anonymous functions with ...
New

We're in Beta

About us Mission Statement