Supra (Supra v3.0.1)

Documentation for Supra.

Summary

Types

change(type)
preloadable()
preloadable(type)
result(type)
result(ok_t, error_t)
stream_by_opt()
stream_by_opts()
stream_opt()
stream_opts()

Functions

count(queryable, list)

Returns the number of rows in queryable

first(queryable, list)

Limits queryable to one result and returns that result

format(query, style \\ :inverse, list)

Returns query as a string with all parameters formatted in the specified style. Styles are rendered via IO.ANSI which will only render stylized text if it thinks the output device can show them.

limit(queryable, count)

Applies limit to queryable

stream(query, opts)

Streams an Ecto query without requiring a transaction.

stream_by(query, field, opts)

Streams an Ecto query without requiring a transaction. Must be given the name of a non-nullable field to iterate over in batches.

Types

change(type)

@type change(type) :: Ecto.Changeset.t(type)

preloadable()

@type preloadable() :: [Ecto.Schema.t()] | Ecto.Schema.t() | nil

preloadable(type)

@type preloadable(type) :: [type] | type | nil

result(type)

@type result(type) :: {:ok, type} | {:error, Ecto.Changeset.t(type)}

result(ok_t, error_t)

@type result(ok_t, error_t) :: {:ok, ok_t} | {:error, Ecto.Changeset.t(error_t)}

stream_by_opt()

@type stream_by_opt() ::
  {:repo, module()}
  | {:batch_size, pos_integer()}
  | {:order, :asc | :desc}
  | {:preload, term()}

stream_by_opts()

@type stream_by_opts() :: [stream_by_opt()]

stream_opt()

@type stream_opt() ::
  {:cursor_fun, (term() -> term())}
  | {:next_batch_fun, (term() -> term())}
  | {:repo, module()}
  | {:batch_size, pos_integer()}
  | {:preload, term()}

stream_opts()

@type stream_opts() :: [stream_opt()]

Functions

count(queryable, list)

@spec count(Ecto.Queryable.t(), [{:repo, Ecto.Repo.t()}]) :: non_neg_integer()

Returns the number of rows in queryable

first(queryable, list)

@spec first(Ecto.Queryable.t(), [{:repo, Ecto.Repo.t()}]) :: Ecto.Schema.t() | nil

Limits queryable to one result and returns that result

format(query, style \\ :inverse, list)

@spec format(Ecto.Queryable.t(), Supra.Format.style(), [{:repo, Ecto.Repo.t()}]) ::
  binary()

Returns query as a string with all parameters formatted in the specified style. Styles are rendered via IO.ANSI which will only render stylized text if it thinks the output device can show them.

  • :bright renders parameters in brighter text, which is the most subtle of all the supported styles and may be hard to differentiate.
  • :color renders parameters in different colors depending on their data types via IO.ANSI.syntax_colors/0.
  • :inverse (the default) renders parameters with an inverse background. This is quite visible and also compatible when some other code such as a logger is colorizing the query.
  • :underline is a bit more subtle than :inverse but more visible than :bright.

limit(queryable, count)

@spec limit(Ecto.Queryable.t(), non_neg_integer()) :: Ecto.Queryable.t()

Applies limit to queryable

stream(query, opts)

@spec stream(Ecto.Query.t(), stream_opts()) :: Enum.t()

Streams an Ecto query without requiring a transaction.

Options

  • cursor_fun :: fun() required - An arity-1 function that will be given the last value returned from the stream. This function will be evaluated to save the cursor value that will be used to find the next batch.
  • next_batch_fun :: fun() required - An arity-1 function that will be given the cursor saved from the previous batch. This function must return an Ecto.Query.dynamic_expr/0 that may used in a where clause to find the next batch.
  • repo :: module() required - An Ecto.Repo execute queries.
  • batch_size :: integer() deault100- The size of batches to query from the database. -preload :: term()optional - An optional set of preloads to apply to each batch before emitting members to the stream. This is preferred over query-time preloads, as described below. ## Warning When streaming a query with query-time preloads, associations may be truncated for the last record of each stream batch. The:preloadoption toSupra.stream/2andSupra.stream_by/3` operates on the returned values of each batch, and thus does not exhibit this problem.

stream_by(query, field, opts)

@spec stream_by(Ecto.Query.t(), atom(), stream_by_opts()) :: Enum.t()

Streams an Ecto query without requiring a transaction. Must be given the name of a non-nullable field to iterate over in batches.

Options

  • repo :: module() required - An Ecto.Repo execute queries.
  • batch_size :: integer() deault100- The size of batches to query from the database. -order :: :asc | :descdefault:asc- The order in which to iterate over batches. -preload :: term()optional - An optional set of preloads to apply to each batch before emitting members to the stream. This is preferred over query-time preloads, as described below. ## Warning When streaming a query with query-time preloads, associations may be truncated for the last record of each stream batch. The:preloadoption toSupra.stream/2andSupra.stream_by/3` operates on the returned values of each batch, and thus does not exhibit this problem.