ash
ash
v2.14.17

View Source Ash.Resource.Change behaviour (ash v2.14.17)

The behaviour for an action-specific resource change.

init/1 is defined automatically by use Ash.Resource.Change, but can be implemented if you want to validate/transform any options passed to the module.

The main function is change/3. It takes the changeset, any options that were provided when this change was configured on a resource, and the context, which currently only has the actor.

Summary

Types

context()
ref()
t()

Callbacks

after_batch(list, t, context)

Runs on each batch result after it is dispatched to the data layer.

batch_change(list, t, context)

Replaces change/3 for batch actions, allowing to optimize changes for bulk actions.

before_batch(list, t, context)

Runs on each batch before it is dispatched to the data layer.

change(t, t, context)
init(t)

Functions

atomic_schema()

Types

Link to this type

context()

View Source 
@type context() :: %{
  optional(:actor) => Ash.Resource.record(),
  optional(any()) => any()
}
Link to this type

ref()

View Source 
@type ref() :: {module(), Keyword.t()} | module()
Link to this type

t()

View Source 
@type t() :: %Ash.Resource.Change{
  change: term(),
  description: term(),
  on: term(),
  only_when_valid?: term(),
  where: term()
}

Callbacks

Link to this callback

after_batch(list, t, context)

View Source (optional) 
@callback after_batch(
  [{Ash.Changeset.t(), Ash.Resource.record()}],
  Keyword.t(),
  context()
) ::
  Enumerable.t(
    {:ok, Ash.Resource.record()}
    | {:error, Ash.Error.t()}
    | Ash.Notifier.Notification.t()
  )

Runs on each batch result after it is dispatched to the data layer.

Link to this callback

batch_change(list, t, context)

View Source (optional) 
@callback batch_change([Ash.Changeset.t()], Keyword.t(), context()) ::
  Enumerable.t(Ash.Changeset.t() | Ash.Notifier.Notification.t())

Replaces change/3 for batch actions, allowing to optimize changes for bulk actions.

Link to this callback

before_batch(list, t, context)

View Source (optional) 
@callback before_batch([Ash.Changeset.t()], Keyword.t(), context()) ::
  Enumerable.t(Ash.Changeset.t() | Ash.Notifier.Notification.t())

Runs on each batch before it is dispatched to the data layer.

Link to this callback

change(t, t, context)

View Source 
@callback change(Ash.Changeset.t(), Keyword.t(), context()) :: Ash.Changeset.t()
Link to this callback

init(t)

View Source 
@callback init(Keyword.t()) :: {:ok, Keyword.t()} | {:error, term()}

Functions

Link to this function

atomic_schema()

View Source