Ash.Calculation behaviour (ash v1.47.6) View Source

The behaviour for a calculation module

Use select/2 to apply a select statement when the calculation is loaded. This does not apply in the case that you are loading on existing resources using MyApi.load. It also doesn't apply when the calculation is used in a filter or sort, because it is not necessary to select fields to power filters done in the data layer.

Link to this section Summary

Callbacks

calculate(list, arg2, map)

describe(arg1)

expression(arg1, map)

init(arg1)

load(arg1, arg2, map)

select(arg1, arg2, map)

Link to this section Callbacks

calculate(list, arg2, map)

(optional)

Specs

calculate([Ash.Resource.record()], Keyword.t(), map()) ::
  {:ok, [term()]} | [term()] | {:error, term()}

describe(arg1)

Specs

describe(Keyword.t()) :: String.t()

expression(arg1, map)

(optional)

Specs

expression(Keyword.t(), map()) :: any()

init(arg1)

Specs

init(Keyword.t()) :: {:ok, Keyword.t()} | {:error, term()}

load(arg1, arg2, map)

Specs

load(Ash.Query.t(), Keyword.t(), map()) :: Ash.Query.t()

select(arg1, arg2, map)

Specs

select(Ash.Query.t(), Keyword.t(), map()) :: [atom()]