Chunkr.Opts (Chunkr v0.1.0) View Source

Options for paginating

Fields

query — the non-paginated query to be extended for pagination purposes.
name — the name of the pagination strategy.
cursor — the cursor beyond which results are retrieved.
paging_dir — either :forward or :backward depending on whether we're paging from the start of the result set toward the end or from the end of the result set toward the beginning.
max_limit — the maximum number of results the user can request per page.
limit — the number of results to actually query for this page.

Link to this section Summary

Types

t()

Functions

new(query, query_name, opts)

Link to this section Types

t()

Specs

t() :: %Chunkr.Opts{
  cursor: Chunkr.Cursor.opaque_cursor() | nil,
  limit: pos_integer(),
  max_limit: pos_integer(),
  name: atom(),
  paging_dir: :forward | :backward,
  queries: atom(),
  query: Ecto.Query.t(),
  repo: atom()
}

Link to this section Functions

new(query, query_name, opts)