View Source Ash.Resource (ash v2.18.2)

A resource is a static definition of an entity in your system.

Resource DSL documentation

Summary

Types

record()

t()

Functions

get_metadata(record, key_or_path)

loaded?(data, path, opts \\ [])

Returns true if the load or path to load has been loaded

put_metadata(record, key, term)

selected?(record, field)

set_metadata(record, map)

unload(page, path)

Sets a loaded key or path to a key back to its original unloaded stated

unload_many(data, paths)

Sets a list of loaded key or paths to a key back to their original unloaded stated

Types

record()

@type record() :: struct()

t()

@type t() :: module()

Functions

get_metadata(record, key_or_path)

@spec get_metadata(record(), atom() | [atom()]) :: term()

loaded?(data, path, opts \\ [])

@spec loaded?(
  nil | [record()] | record() | Ash.Page.page(),
  atom() | Ash.Query.Calculation.t() | Ash.Query.Aggregate.t() | [atom()],
  opts :: Keyword.t()
) :: boolean()

Returns true if the load or path to load has been loaded

Options

lists: set to :any to have this return true if any record in a list that appears has the value loaded. Default is :all.
unknown: set to true to have unknown paths (like nil values or non-resources) return true. Defaults to false

put_metadata(record, key, term)

@spec put_metadata(record(), atom(), term()) :: record()

selected?(record, field)

@spec selected?(record(), atom()) :: boolean()

set_metadata(record, map)

@spec set_metadata(record(), map()) :: record()

unload(page, path)

@spec unload(
  nil | [record()] | record() | Ash.Page.page(),
  atom() | [atom()]
) :: nil | [record()] | record() | Ash.Page.page()

Sets a loaded key or path to a key back to its original unloaded stated

unload_many(data, paths)

@spec unload_many(
  nil | [record()] | record() | Ash.Page.page(),
  [atom()] | [[atom()]]
) :: nil | [record()] | record() | Ash.Page.page()

Sets a list of loaded key or paths to a key back to their original unloaded stated