ash
ash v2.9.24

View Source Ash.Resource.ManualRelationship behaviour (ash v2.9.24)

A module to implement manual relationships.

Link to this section Summary

Types

context()

Callbacks

load( list, opts, context )

Link to this section Types

Link to this type

context()

View Source 
@type context() :: %{
  optional(:relationship) => Ash.Resource.Relationships.relationship(),
  optional(:query) => Ash.Query.t(),
  optional(:actor) => term(),
  optional(:tenant) => term(),
  optional(:authorize?) => boolean(),
  optional(:api) => module(),
  optional(any()) => any()
}

Link to this section Callbacks

Link to this callback

load( list, opts, context )

View Source 
@callback load(
  [Ash.Resource.record()],
  opts :: Keyword.t(),
  context :: context()
) :: {:ok, map()} | {:error, term()}