ash
ash v2.11.8

View Source Ash.Resource.ManualRead behaviour (ash v2.11.8)

A module to implement manual read actions.

Link to this section Summary

Types

context()

Callbacks

read( query, data_layer_query, opts, context )

Link to this section Types

Link to this type

context()

View Source 
@type context() :: %{
  optional(:actor) => term(),
  optional(:tenant) => term(),
  optional(:authorize?) => boolean(),
  optional(:api) => module(),
  optional(any()) => any()
}

Link to this section Callbacks

Link to this callback

read( query, data_layer_query, opts, context )

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