Merge branch 'develop' of git.pleroma.social:pleroma/pleroma into feature/local-only...

[akkoma] / lib / pleroma / repo.ex

diff --git a/lib/pleroma/repo.ex b/lib/pleroma/repo.ex
index a75610879a6c7a78a12a5461ef14160b690a5380..4524bd5e2c766636382ba2c0c34d409d10c289b4 100644 (file)
--- a/lib/pleroma/repo.ex
+++ b/lib/pleroma/repo.ex
@@ -49,6 +49,20 @@ defmodule Pleroma.Repo do
     end
   end
 
+  @doc """
+  Returns a lazy enumerable that emits all entries from the data store matching the given query.
+
+  `returns_as` use to group records. use the `batches` option to fetch records in bulk.
+
+  ## Examples
+
+  # fetch records one-by-one
+  iex> Pleroma.Repo.chunk_stream(Pleroma.Activity.Queries.by_actor(ap_id), 500)
+
+  # fetch records in bulk
+  iex> Pleroma.Repo.chunk_stream(Pleroma.Activity.Queries.by_actor(ap_id), 500, :batches)
+  """
+  @spec chunk_stream(Ecto.Query.t(), integer(), atom()) :: Enumerable.t()
   def chunk_stream(query, chunk_size, returns_as \\ :one) do
     # We don't actually need start and end funcitons of resource streaming,
     # but it seems to be the only way to not fetch records one-by-one and