Bonfire.Common.Repo.Preload (Bonfire v1.0.0-social-rc.1.15)

Helpers for preloading Ecto struct associations

Summary

Functions

maybe_preload(obj, preloads, opts \\ [])

Conditionally preloads associations based on provided options.

maybe_preloads_per_nested_schema(objects, path, preloads, opts \\ [])

Conditionally preloads associations for nested schemas.

maybe_preloads_per_schema(object, schema_and_or_preloads, opts \\ [])

Conditionally preloads associations for a schema.

preload_all(structure, opts \\ [])

Preloads all associations for a given Ecto struct.

preload_mixins(structure, opts \\ [])

Preloads mixin associations for a given Ecto struct.

Functions

maybe_preload(obj, preloads, opts \\ [])

Conditionally preloads associations based on provided options.

Examples

iex> maybe_preload(some_struct, [:assoc1, :assoc2])
%{...}

iex> maybe_preload({:ok, some_struct}, [:assoc1, :assoc2])
{:ok, %{...}}

maybe_preloads_per_nested_schema(objects, path, preloads, opts \\ [])

Conditionally preloads associations for nested schemas.

Examples

iex> maybe_preloads_per_nested_schema(objects, path, preloads)
[%{...}, %{...}]

maybe_preloads_per_schema(object, schema_and_or_preloads, opts \\ [])

Conditionally preloads associations for a schema.

Examples

iex> maybe_preloads_per_schema(some_struct, {Schema, [:assoc1, :assoc2]})

iex> maybe_preloads_per_schema(pointer_struct, {PointerSchema, [:assoc1, :assoc2]})

preload_all(structure, opts \\ [])

Preloads all associations for a given Ecto struct.

Examples

iex> preload_all(some_struct)

preload_mixins(structure, opts \\ [])

Preloads mixin associations for a given Ecto struct.

Examples

iex> preload_mixins(some_struct)