Add option not fetch entries

Author: maartenvanvliet

lib/quarto.ex

@@ -31,6 +31,7 @@ defmodule Quarto do
     * `:cursor` - Module to use for encoding/decoding the cursor
     * `:cursor_fields` - Module to use for building the cursor from a record
     * `:include_total_count` - Set this to true to return the total number of records matching the query. Note that this number will be capped by :total_count_limit. Defaults to false.
+    * `:include_entries` - Set this to false to skip fetching the records. Useful if you only need the total counts. Defaults to true.
     * `:total_count_primary_key_field` - Running count queries on specified column of the table
     * `:limit` - Limits the number of records returned per page. Note that this number will be capped by :maximum_limit. Defaults to `50`.
     * `:maximum_limit` - Sets a maximum cap for :limit. This option can be useful when :limit is set dynamically (e.g from a URL param set by a user) but you still want to enfore a maximum. Defaults to 500.
@@ -201,6 +202,10 @@ defmodule Quarto do
     Enum.count(sorted_entries) <= limit
   end
 
+  defp entries(_, %{include_entries: false}, _, _) do
+    []
+  end
+
   defp entries(queryable, config, repo, repo_opts) do
     queryable
     |> Quarto.Ecto.Query.paginate(config)

lib/quarto/config.ex

@@ -13,6 +13,7 @@ defmodule Quarto.Config do
     :custom_options,
     :transform,
     :include_total_count,
+    :include_entries,
     :limit,
     :maximum_limit,
     :queryable,
@@ -41,6 +42,7 @@ defmodule Quarto.Config do
       coalesce: opts[:coalesce] || fn _field, _position_, _value -> nil end,
       cursor_builder: {Quarto.CursorValue, :build, []},
       cursor_fields: cursor_fields.build(queryable, opts),
+      include_entries: Keyword.get(opts, :include_entries, true),
       include_total_count: opts[:include_total_count] || false,
       total_count_primary_key_field:
         opts[:total_count_primary_key_field] || @default_total_count_primary_key_field,

test/quarto_test.exs

@@ -482,6 +482,28 @@ defmodule QuartoTest do
     end)
   end
 
+  describe "with include_entries" do
+    test "when set to false" do
+      %Page{metadata: metadata, entries: entries} =
+        posts_by_published_at(:desc)
+        |> paginate(
+          limit: 5,
+          total_count_limit: :infinity,
+          include_total_count: true,
+          include_entries: false
+        )
+
+      assert entries == []
+
+      assert metadata == %Metadata{
+               before: nil,
+               limit: 5,
+               total_count: 12,
+               total_count_cap_exceeded: false
+             }
+    end
+  end
+
   describe "with include_total_count" do
     test "when set to :infinity", %{
       posts: {_p1, _p2, _p3, _p4, p5, _p6, _p7, _p8, _p9, _p10, _p11, _p12}
@@ -649,8 +671,10 @@ defmodule QuartoTest do
 
       assert_receive({:query, queryable})
 
-      assert "#Ecto.Query<from p0 in Quarto.Post, where: coalesce(p0.position, ^100) == ^3 and (coalesce(p0.id, ^10) > ^10 and ^true) or coalesce(p0.position, ^100) < ^3 and ^true and ^true, order_by: [desc: coalesce(p0.position, ^100), asc: coalesce(p0.id, ^10)], limit: ^6>" ==
-               inspect(queryable)
+      assert """
+             #Ecto.Query<from p0 in Quarto.Post, where: (coalesce(p0.position, ^100) == ^3 and (coalesce(p0.id, ^10) > ^10 and ^true)) or
+               (coalesce(p0.position, ^100) < ^3 and ^true and ^true), order_by: [desc: coalesce(p0.position, ^100), asc: coalesce(p0.id, ^10)], limit: ^6>
+             """ == inspect(queryable) <> "\n"
     end
   end