View Source Ash.Changeset (ash v2.19.10)

Changesets are used to create and update data in Ash.

Create a changeset with new/1 or new/2, and alter the attributes and relationships using the functions provided in this module. Nothing in this module actually incurs changes in a data layer. To commit a changeset, see Ash.Api.create/2 and Ash.Api.update/2.

See the action DSL documentation for more.

Summary

Functions

Returns a list of attributes, aggregates, relationships, and calculations that are being loaded

Adds an error to the changesets errors list, and marks the change as valid?: false.

Adds an after_action hook to the changeset.

Adds an after_transaction hook to the changeset.

Appends a record or a list of records to a relationship.

Returns the original data with attribute changes merged, if the changeset is valid.

Adds an around_action hook to the changeset.

Adds an around_transaction hook to the changeset.

Gets a reference to a field, or the current atomic update expression of that field.

Adds multiple atomic changes to the changeset

Adds an atomic change to the changeset.

Adds a before_action hook to the changeset.

Adds a before_transaction hook to the changeset.

Adds a change to the changeset, unless the value matches the existing value.

Calls change_attribute/3 for each key/value pair provided.

The same as change_attribute, but annotates that the attribute is currently holding a default value.

Change an attribute only if is not currently being changed

Change an attribute if is not currently being changed, by calling the provided function.

Returns true if an attribute exists in the changes

Returns true if any attributes on the resource are being changed.

Returns true if a relationship exists in the changes

Clears an attribute or relationship change off of the changeset.

Remove an argument from the changeset

Ensure the the specified attributes are nil in the changeset results.

Ensures that the given attributes are selected.

Turns the special case {:replace, fields}, :replace_all and {:replace_all_except, fields} upsert_fields options into a list of fields

Fetches the value of an argument provided to the changeset or :error.

Gets the value of an argument provided to the changeset, falling back to Ash.Changeset.fetch_change/2 if nothing was provided.

Gets the new value for an attribute, or :error if it is not being changed.

Adds a filter for a record being updated or destroyed.

Constructs a changeset for a given action, and validates it.

Constructs a changeset for a given create action, and validates it.

Constructs a changeset for a given destroy action, and validates it.

Constructs a changeset for a given update action, and validates it.

Changes an attribute even if it isn't writable

Force change an attribute if it is not currently being changed.

Force change an attribute if it is not currently being changed, by calling the provided function.

Add an argument to the changeset, which will be provided to the action.

Merge a map of arguments to the arguments list.

Gets the value of an argument provided to the changeset.

Gets the value of an argument provided to the changeset, falling back to Ash.Changeset.get_attribute/2 if nothing was provided.

Gets the changing value or the original value of an attribute.

Gets the original value for an attribute

Sets a custom error handler on the changeset.

Calls the provided load statement on the result of the action at the very end of the action.

Returns true if the field/relationship or path to field/relationship is being loaded.

Manages the related records by creating, updating, or destroying them as necessary.

Returns a new changeset over a resource.

Checks if an attribute is not nil, either in the original data, or that it is not being changed to a nil value if it is changing.

Puts a key/value in the changeset context that can be used later.

Removes a record or a list of records to a relationship.

Ensure that only the specified attributes are present in the results.

Add an argument to the changeset, which will be provided to the action.

Merge a map of arguments to the arguments list.

Deep merges the provided map into the changeset context that can be used later.

Set the result of the action. This will prevent running the underlying datalayer behavior

Wraps a function in the before/after action hooks of a changeset.

Types

@type after_action_fun() ::
  (t(), Ash.Resource.record() ->
     {:ok, Ash.Resource.record()}
     | {:ok, Ash.Resource.record(), [Ash.Notifier.Notification.t()]}
     | {:error, any()})
Link to this type

after_transaction_fun()

View Source
@type after_transaction_fun() ::
  (t(), {:ok, Ash.Resource.record()} | {:error, any()} ->
     {:ok, Ash.Resource.record()} | {:error, any()})
@type around_action_fun() :: (t(), around_callback() -> around_result())
@type around_callback() :: (t() -> around_result())
@type around_result() ::
  {:ok, Ash.Resource.record(), t(),
   %{notifications: [Ash.Notifier.Notification.t()]}}
  | {:error, Ash.Error.t()}
Link to this type

around_transaction_fun()

View Source
@type around_transaction_fun() ::
  (t() -> {:ok, Ash.Resource.record()} | {:error, any()})
@type before_action_fun() ::
  (t() -> t() | {t(), %{notifications: [Ash.Notifier.Notification.t()]}})
Link to this type

before_transaction_fun()

View Source
@type before_transaction_fun() :: (t() -> t())
@type error_info() ::
  String.t()
  | [field: atom(), fields: [atom()], message: String.t(), value: any()]
  | %{:__struct__ => atom(), required(atom()) => any()}
Link to this type

manage_relationship_type()

View Source
@type manage_relationship_type() ::
  :append_and_remove | :append | :remove | :direct_control | :create
@type t() :: %Ash.Changeset{
  __validated_for_action__: atom() | nil,
  action: Ash.Resource.Actions.action() | nil,
  action_failed?: boolean(),
  action_type: Ash.Resource.Actions.action_type() | nil,
  after_action: [after_action_fun() | {after_action_fun(), map()}],
  after_transaction: [
    after_transaction_fun() | {after_transaction_fun(), map()}
  ],
  api: module() | nil,
  arguments: %{optional(atom()) => any()},
  around_action: [around_action_fun() | {around_action_fun(), map()}],
  around_transaction: [
    around_transaction_fun() | {around_transaction_fun(), map()}
  ],
  atomic_validations: term(),
  atomics: Keyword.t(),
  attributes: %{optional(atom()) => any()},
  before_action: [before_action_fun() | {around_action_fun(), map()}],
  before_transaction: [
    before_transaction_fun() | {before_transaction_fun(), map()}
  ],
  casted_arguments: term(),
  casted_attributes: term(),
  context: map(),
  data: Ash.Resource.record() | nil,
  defaults: [atom()],
  errors: [Ash.Error.t()],
  filters: term(),
  handle_errors:
    nil
    | (t(), error :: any() ->
         :ignore | t() | (error :: any()) | {error :: any(), t()}),
  invalid_keys: MapSet.t(),
  load: keyword(keyword()),
  params: %{optional(atom() | binary()) => any()},
  phase:
    :validate
    | :before_transaction
    | :before_action
    | :after_action
    | :after_transaction
    | :around_action
    | :around_transaction,
  relationships: %{
    optional(atom()) =>
      %{optional(atom() | binary()) => any()}
      | [%{optional(atom() | binary()) => any()}]
  },
  resource: module(),
  select: [atom()] | nil,
  tenant: term(),
  timeout: pos_integer() | nil,
  valid?: boolean()
}

Functions

Link to this function

accessing(changeset, types \\ [:attributes, :relationships, :calculations, :attributes])

View Source

Returns a list of attributes, aggregates, relationships, and calculations that are being loaded

Provide a list of field types to narrow down the returned results.

Link to this function

add_error(changeset, errors, path \\ [])

View Source
@spec add_error(t(), error_info() | [error_info()], Keyword.t()) :: t()

Adds an error to the changesets errors list, and marks the change as valid?: false.

Error Data

The given errors argument can be a string, a keyword list, a struct, or a list of any of the three.

If errors is a keyword list, or a list of keyword lists, the following keys are supported in the keyword list:

  • field (atom) - the field that the error is for. This is required, unless fields is given.
  • fields (list of atoms) - the fields that the error is for. This is required, unless field is given.
  • message (string) - the error message
  • value (any) - (optional) the field value that caused the error
Link to this function

after_action(changeset, func, opts \\ [])

View Source
@spec after_action(
  t(),
  after_action_fun(),
  Keyword.t()
) :: t()

Adds an after_action hook to the changeset.

Provide the option prepend?: true to place the hook before all other hooks instead of after.

Link to this function

after_transaction(changeset, func, opts \\ [])

View Source
@spec after_transaction(
  t(),
  after_transaction_fun(),
  Keyword.t()
) :: t()

Adds an after_transaction hook to the changeset.

after_transaction hooks differ from after_action hooks in that they are run on success and failure of the action or some previous hook.

Provide the option prepend?: true to place the hook before all other hooks instead of after.

Link to this function

append_to_relationship(changeset, relationship, record_or_records, opts \\ [])

View Source
This function is deprecated. Use manage_relationship/4 instead.
@spec append_to_relationship(
  t(),
  atom(),
  Ash.Resource.record()
  | map()
  | term()
  | [Ash.Resource.record() | map() | term()],
  Keyword.t()
) :: t()

Appends a record or a list of records to a relationship.

Alias for:

manage_relationship(changeset, relationship, input,
  on_lookup: :relate, # If a record is not in the relationship, and can be found, relate it
  on_no_match: :error, # If a record is not found in the relationship or the database, we error
  on_match: :ignore, # If a record is found in the relationship we don't change it
  on_missing: :ignore, # If a record is not found in the input, we ignore it
)

Provide opts to customize/override the behavior.

Link to this function

apply_attributes(changeset, opts \\ [])

View Source
@spec apply_attributes(t(), opts :: Keyword.t()) ::
  {:ok, Ash.Resource.record()} | {:error, t()}

Returns the original data with attribute changes merged, if the changeset is valid.

Options:

  • force? - applies current attributes even if the changeset is not valid
Link to this function

around_action(changeset, func)

View Source
@spec around_action(t(), around_action_fun()) :: t()

Adds an around_action hook to the changeset.

Your function will get the changeset, and a callback that must be called with a changeset (that may be modified). The callback will return {:ok, result, instructions} or {:error, error}. You can modify these values, but the return value must be one of those types. Instructions contains the notifications in its notifications key, i.e %{notifications: [%Ash.Resource.Notification{}, ...]}.

The around_action calls happen first, and then (after they each resolve their callbacks) the before_action hooks are called, followed by the action itself occurring at the data layer and then the after_action hooks being run. Then, the code that appeared after the callbacks were called is then run.

For example:

changeset
|> Ash.Changeset.around_action(fn changeset, callback ->
  IO.puts("first around: before")
  result = callback.(changeset)
  IO.puts("first around: after")

  result
end)
|> Ash.Changeset.around_action(fn changeset, callback ->
  IO.puts("second around: before")
  result = callback.(changeset)
  IO.puts("second around: after")

  result
end)
|> Ash.Changeset.before_action(fn changeset ->
  IO.puts("first before")
  changeset
end, append?: true)
|> Ash.Changeset.before_action(fn changeset ->
  IO.puts("second before")
  changeset
end, append?: true)
|> Ash.Changeset.after_action(fn changeset, result ->
  IO.puts("first after")
  {:ok, result}
end)
|> Ash.Changeset.after_action(fn changeset, result ->
  IO.puts("second after")
  {:ok, result}
end)

This would print:

first around: before
second around: before
first before
second before
             <-- action happens here
first after
second after
second around: after <-- Notice that because of the callbacks, the after of the around hooks is reversed from the before
first around: after

Warning: using this without understanding how it works can cause big problems. You must call the callback function that is provided to your hook, and the return value must contain the same structure that was given to you, i.e {:ok, result_of_action, instructions}.

You can almost always get the same effect by using before_action, setting some context on the changeset and reading it out in an after_action hook.

Link to this function

around_transaction(changeset, func)

View Source
@spec around_transaction(t(), around_transaction_fun()) :: t()

Adds an around_transaction hook to the changeset.

Your function will get the changeset, and a callback that must be called with a changeset (that may be modified). The callback will return {:ok, result} or {:error, error}. You can modify these values, but the return value must be one of those types.

The around_transaction calls happen first, and then (after they each resolve their callbacks) the before_transaction hooks are called, followed by the action hooks and then the after_transaction hooks being run. Then, the code that appeared after the callbacks were called is then run.

For example:

changeset
|> Ash.Changeset.around_transaction(fn changeset, callback ->
  IO.puts("first around: before")
  result = callback.(changeset)
  IO.puts("first around: after")

  result
end)
|> Ash.Changeset.around_transaction(fn changeset, callback ->
  IO.puts("second around: before")
  result = callback.(changeset)
  IO.puts("second around: after")

  result
end)
|> Ash.Changeset.before_transaction(fn changeset ->
  IO.puts("first before")
  changeset
end, append?: true)
|> Ash.Changeset.before_transaction(fn changeset ->
  IO.puts("second before")
  changeset
end, append?: true)
|> Ash.Changeset.after_transaction(fn changeset, result ->
  IO.puts("first after")
  result
end)
|> Ash.Changeset.after_transaction(fn changeset, result ->
  IO.puts("second after")
  result
end)

This would print:

first around: before
second around: before
first before
second before
             <-- action hooks happens here
first after
second after
second around: after <-- Notice that because of the callbacks, the after of the around hooks is reversed from the before
first around: after

Warning: using this without understanding how it works can cause big problems. You must call the callback function that is provided to your hook, and the return value must contain the same structure that was given to you, i.e {:ok, result_of_action}.

You can almost always get the same effect by using before_transaction, setting some context on the changeset and reading it out in an after_transaction hook.

Link to this function

atomic_ref(changeset, field)

View Source

Gets a reference to a field, or the current atomic update expression of that field.

Link to this function

atomic_update(changeset, atomics)

View Source
@spec atomic_update(t(), map() | Keyword.t()) :: t()

Adds multiple atomic changes to the changeset

See atomic_update/3 for more information.

Link to this function

atomic_update(changeset, key, value)

View Source
@spec atomic_update(t(), atom(), {:atomic, Ash.Expr.t()} | Ash.Expr.t()) :: t()

Adds an atomic change to the changeset.

Atomic changes are applied by the data layer, and as such have guarantees that are not given by changes that are based on looking at the previous value and updating it. Here is an example of a change that is not safe to do concurrently:

change fn changeset, _ ->
  Ash.Changeset.set_attribute(changeset, :score, changeset.data.score + 1)
end

If two processes run this concurrently, they will both read the same value of score, and set the new score to the same value. This means that one of the increments will be lost. If you were to instead do this using atomic_update, you would get the correct result:

Ash.Changeset.atomic_update(changeset, :score, [Ash.Expr.expr(score + 1)])

There are drawbacks/things to consider, however. The first is that atomic update results are not known until after the action is run. The following functional validation would not be able to enforce the score being less than 10, because the atomic happens after the validation.

validate fn changeset, _ ->
  if Ash.Changeset.get_attribute(changeset, :score) < 10 do
    :ok
  else
    {:error, field: :score, message: "must be less than 10"}
  end
end

If you want to use atomic updates, it is suggested to write module-based validations & changes, and implement the appropriate atomic callbacks on those modules. All builtin validations and changes implement these callbacks in addition to the standard callbacks. Validations will only be run atomically when the entire action is being run atomically or if one of the relevant fields is being updated atomically.

Link to this function

before_action(changeset, func, opts \\ [])

View Source
@spec before_action(
  t(),
  before_action_fun(),
  Keyword.t()
) :: t()

Adds a before_action hook to the changeset.

Provide the option append?: true to place the hook after all other hooks instead of before.

Link to this function

before_transaction(changeset, func, opts \\ [])

View Source
@spec before_transaction(
  t(),
  before_transaction_fun(),
  Keyword.t()
) :: t()

Adds a before_transaction hook to the changeset.

Provide the option append?: true to place the hook after all other hooks instead of before.

Link to this function

change_attribute(changeset, attribute, value)

View Source
@spec change_attribute(t(), atom(), any()) :: t()

Adds a change to the changeset, unless the value matches the existing value.

Link to this function

change_attributes(changeset, changes)

View Source
@spec change_attributes(t(), map() | Keyword.t()) :: t()

Calls change_attribute/3 for each key/value pair provided.

Link to this function

change_default_attribute(changeset, attribute, value)

View Source
@spec change_default_attribute(t(), atom(), any()) :: t()

The same as change_attribute, but annotates that the attribute is currently holding a default value.

This information can be used in changes to see if a value was explicitly set or if it was set by being the default. Additionally, this is used in upsert actions to not overwrite existing values with the default.

Link to this function

change_new_attribute(changeset, attribute, value)

View Source
@spec change_new_attribute(t(), atom(), term()) :: t()

Change an attribute only if is not currently being changed

Link to this function

change_new_attribute_lazy(changeset, attribute, func)

View Source
@spec change_new_attribute_lazy(t(), atom(), (-> any())) :: t()

Change an attribute if is not currently being changed, by calling the provided function.

Use this if you want to only perform some expensive calculation for an attribute value only if there isn't already a change for that attribute.

Link to this function

changing_attribute?(changeset, attribute)

View Source
@spec changing_attribute?(t(), atom()) :: boolean()

Returns true if an attribute exists in the changes

Link to this function

changing_attributes?(changeset)

View Source
@spec changing_attributes?(t()) :: boolean()

Returns true if any attributes on the resource are being changed.

Link to this function

changing_relationship?(changeset, relationship)

View Source
@spec changing_relationship?(t(), atom()) :: boolean()

Returns true if a relationship exists in the changes

Link to this function

clear_change(changeset, field)

View Source

Clears an attribute or relationship change off of the changeset.

Link to this function

delete_argument(changeset, argument_or_arguments)

View Source

Remove an argument from the changeset

Link to this function

deselect(changeset, fields)

View Source

Ensure the the specified attributes are nil in the changeset results.

Link to this function

ensure_selected(changeset, fields)

View Source

Ensures that the given attributes are selected.

The first call to select/2 will limit the fields to only the provided fields. Use ensure_selected/2 to say "select this field (or these fields) without deselecting anything else".

See select/2 for more.

Link to this function

expand_upsert_fields(fields, resource)

View Source

Turns the special case {:replace, fields}, :replace_all and {:replace_all_except, fields} upsert_fields options into a list of fields

Link to this function

fetch_argument(changeset, argument)

View Source
@spec fetch_argument(t(), atom()) :: {:ok, term()} | :error

Fetches the value of an argument provided to the changeset or :error.

Link to this function

fetch_argument_or_change(changeset, attribute)

View Source
@spec fetch_argument_or_change(t(), atom()) :: {:ok, any()} | :error

Gets the value of an argument provided to the changeset, falling back to Ash.Changeset.fetch_change/2 if nothing was provided.

Link to this function

fetch_change(changeset, attribute)

View Source
@spec fetch_change(t(), atom()) :: {:ok, any()} | :error

Gets the new value for an attribute, or :error if it is not being changed.

Link to this function

filter(changeset, fields)

View Source
@spec filter(t(), %{optional(atom()) => term()}) :: t()

Adds a filter for a record being updated or destroyed.

Used by optimistic locking. See Ash.Resource.Change.Builtins.optimistic_lock/1 for more.

Link to this function

for_action(initial, action, params \\ %{}, opts \\ [])

View Source

Constructs a changeset for a given action, and validates it.

Calls for_create/4, for_update/4 or for_destroy/4 based on the type of action passed in.

See those functions for more explanation.

Link to this function

for_create(initial, action, params \\ %{}, opts \\ [])

View Source

Constructs a changeset for a given create action, and validates it.

Anything that is modified prior to for_create/4 is validated against the rules of the action, while anything after it is not. This runs any changes contained on your action. To have your logic execute only during the action, you can use after_action/2 or before_action/2.

Multitenancy is not validated until an action is called. This allows you to avoid specifying a tenant until just before calling the api action.

Params

params may be attributes, relationships, or arguments. You can safely pass user/form input directly into this function. Only public attributes and relationships are supported. If you want to change private attributes as well, see the Customization section below. params are stored directly as given in the params field of the changeset, which is used

Opts

  • :require? (boolean/0) - If set to false, values are only required when the action is run (instead of immediately). The default value is false.

  • :actor (term/0) - set the actor, which can be used in any Ash.Resource.Changes configured on the action. (in the context argument)

  • :authorize? (term/0) - set authorize?, which can be used in any Ash.Resource.Changes configured on the action. (in the context argument)

  • :tracer - A tracer to use. Will be carried over to the action. For more information see Ash.Tracer.

  • :tenant (term/0) - set the tenant on the changeset

Customization

A changeset can be provided as the first argument, instead of a resource, to allow setting specific attributes ahead of time.

For example:

MyResource
|> Ash.Changeset.new()
|> Ash.Changeset.change_attribute(:foo, 1)
|> Ash.Changeset.for_create(:create, ...opts)

Once a changeset has been validated by for_create/4 (or for_update/4), it isn't validated again in the action. New changes added are validated individually, though. This allows you to create a changeset according to a given action, and then add custom changes if necessary.

Link to this function

for_destroy(initial, action_or_name, params \\ %{}, opts \\ [])

View Source

Constructs a changeset for a given destroy action, and validates it.

Opts

  • :actor - set the actor, which can be used in any Ash.Resource.Changes configured on the action. (in the context argument)
  • :tenant - set the tenant on the changeset

Anything that is modified prior to for_destroy/4 is validated against the rules of the action, while anything after it is not.

Once a changeset has been validated by for_destroy/4, it isn't validated again in the action. New changes added are validated individually, though. This allows you to create a changeset according to a given action, and then add custom changes if necessary.

Link to this function

for_update(initial, action, params \\ %{}, opts \\ [])

View Source

Constructs a changeset for a given update action, and validates it.

Anything that is modified prior to for_update/4 is validated against the rules of the action, while anything after it is not.

See for_create/4 for more information

Link to this function

force_change_attribute(changeset, attribute, value)

View Source
@spec force_change_attribute(t(), atom(), any()) :: t()

Changes an attribute even if it isn't writable

Link to this function

force_change_attributes(changeset, changes)

View Source
@spec force_change_attributes(t(), map() | Keyword.t()) :: t()

Calls force_change_attribute/3 for each key/value pair provided.

Link to this function

force_change_new_attribute(changeset, attribute, value)

View Source
@spec force_change_new_attribute(t(), atom(), term()) :: t()

Force change an attribute if it is not currently being changed.

See change_new_attribute/3 for more.

Link to this function

force_change_new_attribute_lazy(changeset, attribute, func)

View Source
@spec force_change_new_attribute_lazy(t(), atom(), (-> any())) :: t()

Force change an attribute if it is not currently being changed, by calling the provided function.

See change_new_attribute_lazy/3 for more.

Link to this function

force_set_argument(changeset, argument, value)

View Source

Add an argument to the changeset, which will be provided to the action.

Does not show a warning when used in before/after action hooks.

Link to this function

force_set_arguments(changeset, map)

View Source

Merge a map of arguments to the arguments list.

Does not show a warning when used in before/after action hooks.

Link to this function

fully_atomic_changeset(resource, action, params, opts \\ [])

View Source
@spec fully_atomic_changeset(
  resource :: Ash.Resource.t(),
  action :: atom() | Ash.Resource.Actions.action(),
  params :: map(),
  opts :: Keyword.t()
) :: t() | {:not_atomic, String.t()}
Link to this function

get_argument(changeset, argument)

View Source
@spec get_argument(t(), atom()) :: term()

Gets the value of an argument provided to the changeset.

Link to this function

get_argument_or_attribute(changeset, attribute)

View Source
@spec get_argument_or_attribute(t(), atom()) :: term()

Gets the value of an argument provided to the changeset, falling back to Ash.Changeset.get_attribute/2 if nothing was provided.

Link to this function

get_attribute(changeset, attribute)

View Source
@spec get_attribute(t(), atom()) :: term()

Gets the changing value or the original value of an attribute.

Link to this function

get_data(changeset, attribute)

View Source
@spec get_data(t(), atom()) :: term()

Gets the original value for an attribute

Link to this function

handle_errors(changeset, func)

View Source
@spec handle_errors(
  t(),
  (t(), error :: term() ->
     :ignore | t() | (error :: term()) | {error :: term(), t()})
  | {module(), atom(), [term()]}
) :: t()

Sets a custom error handler on the changeset.

The error handler should be a two argument function or an mfa, in which case the first two arguments will be set to the changeset and the error, w/ the supplied arguments following those.

Any errors generated are passed to handle_errors, which can return any of the following:

  • :ignore - the error is discarded, and the changeset is not marked as invalid
  • changeset - a new (or the same) changeset. The error is not added (you'll want to add an error yourself), but the changeset is marked as invalid.
  • {changeset, error} - a new (or the same) error and changeset. The error is added to the changeset, and the changeset is marked as invalid.
  • anything_else - is treated as a new, transformed version of the error. The result is added as an error to the changeset, and the changeset is marked as invalid.
Link to this function

handle_params(changeset, action, params, handle_params_opts \\ [])

View Source
@spec load(t(), term()) :: t()

Calls the provided load statement on the result of the action at the very end of the action.

Link to this function

loading?(changeset, path)

View Source

Returns true if the field/relationship or path to field/relationship is being loaded.

It accepts an atom or a list of atoms, which is treated for as a "path", i.e:

Resource |> Ash.Changeset.load(friends: [enemies: [:score]]) |> Ash.Changeset.loading?([:friends, :enemies, :score])
iex> true

Resource |> Ash.Changeset.load(friends: [enemies: [:score]]) |> Ash.Changeset.loading?([:friends, :score])
iex> false

Resource |> Ash.Changeset.load(friends: [enemies: [:score]]) |> Ash.Changeset.loading?(:friends)
iex> true
Link to this function

manage_relationship(changeset, relationship, input, opts \\ [])

View Source

Manages the related records by creating, updating, or destroying them as necessary.

Keep in mind that the default values for all on_* are :ignore, meaning nothing will happen unless you provide instructions.

The input provided to manage_relationship should be a map, in the case of to_one relationships, or a list of maps in the case of to_many relationships. The following steps are followed for each input provided:

  • The input is checked against the currently related records to find any matches. The primary key and unique identities are used to find matches.
  • For any input that had a match in the current relationship, the :on_match behavior is triggered
  • For any input that does not have a match:
    • if there is on_lookup behavior:
      • we try to find the record in the data layer.
      • if the record is found, the on_lookup behavior is triggered
      • if the record is not found, the on_no_match behavior is triggered
    • if there is no on_lookup behavior:
      • the on_no_match behavior is triggered
  • finally, for any records present in the current relationship that had no match in the input, the on_missing behavior is triggered

Options

  • :type - If the type is specified, the default values of each option is modified to match that type of operation.
    This allows for specifying certain operations much more succinctly. The defaults that are modified are listed below:

    • :append_and_remove
      [
        on_lookup: :relate,
        on_no_match: :error,
        on_match: :ignore,
        on_missing: :unrelate
      ]  
    • :append
      [
        on_lookup: :relate,
        on_no_match: :error,
        on_match: :ignore,
        on_missing: :ignore
      ]  
    • :remove
      [
        on_no_match: :error,
        on_match: :unrelate,
        on_missing: :ignore
      ]  
    • :direct_control
      [
        on_lookup: :ignore,
        on_no_match: :create,
        on_match: :update,
        on_missing: :destroy
      ]  
    • :create
      [
        on_no_match: :create,
        on_match: :ignore
      ]
      Valid values are :append_and_remove, :append, :remove, :direct_control, :create
  • :authorize? (boolean/0) - Authorize reads and changes to the destination records, if the primary change is being authorized as well. The default value is true.

  • :eager_validate_with (atom/0) - Validates that any referenced entities exist before the action is being performed, using the provided API for the read. The default value is false.

  • :on_no_match (term/0) - Instructions for handling records where no matching record existed in the relationship.

    • :ignore (default) - those inputs are ignored
    • :match - For has_one and belongs_to only, any input is treated as a match for an existing value. For has_many and many_to_many, this is the same as :ignore.
    • :create - the records are created using the destination's primary create action
    • {:create, :action_name} - the records are created using the specified action on the destination resource
    • {:create, :action_name, :join_table_action_name, [:list, :of, :join_table, :params]} - Same as {:create, :action_name} but takes the list of params specified out and applies them when creating the join record, with the provided join_table_action_name.
    • :error - an error is returned indicating that a record would have been created
      • If on_lookup is set, and the data contained a primary key or identity, then the error is a NotFound error
      • Otherwise, an InvalidRelationship error is returned The default value is :ignore.
  • :value_is_key (atom/0) - Configures what key to use when a single value is provided.
    This is useful when you use things like a list of strings i.e friend_emails to manage the relationship, instead of a list of maps.
    By default, we assume it is the primary key of the destination resource, unless it is a composite primary key.

  • :identity_priority (list of atom/0) - The list, in priority order, of identities to use when looking up records for on_lookup, and matching records with on_match.
    Use :_primary_key to prioritize checking a match with the primary key. All identities, along with :_primary_key are checked regardless, this only allows ensuring that some are checked first. Defaults to the list provided by use_identities, so you typically won't need this option.

  • :use_identities (list of atom/0) - A list of identities that may be used to look up and compare records. Use :_primary_key to include the primary key. By default, only [:_primary_key] is used.

  • :on_lookup (term/0) - Before creating a record (because no match was found in the relationship), the record can be looked up and related.

    • :ignore (default) - Does not look for existing entries (matches in the current relationship are still considered updates)
    • :relate - Same as calling {:relate, primary_action_name}
    • {:relate, :action_name} - the records are looked up by primary key/the first identity that is found (using the primary read action), and related. The action should be:
      • many_to_many - a create action on the join resource
      • has_many - an update action on the destination resource
      • has_one - an update action on the destination resource
      • belongs_to - an update action on the source resource
    • {:relate, :action_name, :read_action_name} - Same as the above, but customizes the read action called to search for matches.
    • :relate_and_update - Same as :relate, but the remaining parameters from the lookup are passed into the action that is used to change the relationship key
    • {:relate_and_update, :action_name} - Same as the above, but customizes the action used. The action should be:
      • many_to_many - a create action on the join resource
      • has_many - an update action on the destination resource
      • has_one - an update action on the destination resource
      • belongs_to - an update action on the source resource
    • {:relate_and_update, :action_name, :read_action_name} - Same as the above, but customizes the read action called to search for matches.
    • {:relate_and_update, :action_name, :read_action_name, [:list, :of, :join_table, :params]} - Same as the above, but uses the provided list of parameters when creating the join row (only relevant for many to many relationships). Use :all to only update the join record, and pass all parameters to its action The default value is :ignore.
  • :on_match (term/0) - Instructions for handling records where a matching record existed in the relationship already.

    • :ignore (default) - those inputs are ignored
    • :update - the record is updated using the destination's primary update action
    • {:update, :action_name} - the record is updated using the specified action on the destination resource
    • {:update, :action_name, :join_table_action_name, [:list, :of, :params]} - Same as {:update, :action_name} but takes the list of params specified out and applies them as an update to the join record (only valid for many to many)
    • :update_join - update only the join record (only valid for many to many)
    • {:update_join, :join_table_action_name} - use the specified update action on a join resource
    • {:update_join, :join_table_action_name, [:list, :of, :params]} - pass specified params from input into a join resource update action
    • {:destroy, :action_name} - the record is destroyed using the specified action on the destination resource. The action should be:
      • many_to_many - a destroy action on the join record
      • has_many - a destroy action on the destination resource
      • has_one - a destroy action on the destination resource
      • belongs_to - a destroy action on the destination resource
    • :error - an error is returned indicating that a record would have been updated
    • :no_match - follows the on_no_match instructions with these records
    • :missing - follows the on_missing instructions with these records
    • :unrelate - the related item is not destroyed, but the data is "unrelated", making this behave like remove_from_relationship/3. The action should be:
      • many_to_many - the join resource row is destroyed
      • has_many - the destination_attribute (on the related record) is set to nil
      • has_one - the destination_attribute (on the related record) is set to nil
      • belongs_to - the source_attribute (on this record) is set to nil
    • {:unrelate, :action_name} - the record is unrelated using the provided update action. The action should be:
      • many_to_many - a destroy action on the join resource
      • has_many - an update action on the destination resource
      • has_one - an update action on the destination resource
      • belongs_to - an update action on the source resource The default value is :ignore.
  • :on_missing (term/0) - Instructions for handling records that existed in the current relationship but not in the input.

    • :ignore (default) - those inputs are ignored
    • :destroy - the record is destroyed using the destination's primary destroy action
    • {:destroy, :action_name} - the record is destroyed using the specified action on the destination resource
    • {:destroy, :action_name, :join_resource_action_name} - the record is destroyed using the specified action on the destination resource, but first the join resource is destroyed with its specified action
    • :error - an error is returned indicating that a record would have been updated
    • :unrelate - the related item is not destroyed, but the data is "unrelated", making this behave like remove_from_relationship/3. The action should be:
      • many_to_many - the join resource row is destroyed
      • has_many - the destination_attribute (on the related record) is set to nil
      • has_one - the destination_attribute (on the related record) is set to nil
      • belongs_to - the source_attribute (on this record) is set to nil
    • {:unrelate, :action_name} - the record is unrelated using the provided update action. The action should be:
      • many_to_many - a destroy action on the join resource
      • has_many - an update action on the destination resource
      • has_one - an update action on the destination resource
      • belongs_to - an update action on the source resource The default value is :ignore.
  • :error_path (term/0) - By default, errors added to the changeset will use the path [:relationship_name], or [:relationship_name, <index>]. If you want to modify this path, you can specify error_path, e.g if had a change on an action that takes an argument and uses that argument data to call manage_relationship, you may want any generated errors to appear under the name of that argument, so you could specify error_path: :argument_name when calling manage_relationship.

  • :join_keys (list of atom/0) - For many to many relationships specifies the parameters to pick from the input and pass into a join resource action. Applicable in cases like on_no_match: :create, on_match: :update and on_lookup: :relate. Can be overwritten by a full form instruction tuple which contains join parameters at the end.

  • :meta (term/0) - Freeform data that will be retained along with the options, which can be used to track/manage the changes that are added to the relationships key.

  • :ignore? (term/0) - This tells Ash to ignore the provided inputs when actually running the action. This can be useful for building up a set of instructions that you intend to handle manually. The default value is false.

Each call to this function adds new records that will be handled according to their options. For example, if you tracked "tags to add" and "tags to remove" in separate fields, you could input them like so:

changeset
|> Ash.Changeset.manage_relationship(
  :tags,
  [%{name: "backend"}],
  on_lookup: :relate, #relate that tag if it exists in the database
  on_no_match: :error # error if a tag with that name doesn't exist
)
|> Ash.Changeset.manage_relationship(
  :tags,
  [%{name: "frontend"}],
  on_no_match: :error, # error if a tag with that name doesn't exist in the relationship
  on_match: :unrelate # if a tag with that name is related, unrelate it
)

When calling this multiple times with the on_missing option set, the list of records that are considered missing are checked after each set of inputs is processed. For example, if you manage the relationship once with on_missing: :unrelate, the records missing from your input will be removed, and then your next call to manage_relationship will be resolved (with those records unrelated). For this reason, it is suggested that you don't call this function multiple times with an on_missing instruction, as you may be surprised by the result.

If you want the input to update existing entities, you need to ensure that the primary key (or unique identity) is provided as part of the input. See the example below:

changeset
|> Ash.Changeset.manage_relationship(
  :comments,
  [%{rating: 10, contents: "foo"}],
  on_no_match: {:create, :create_action},
  on_missing: :ignore
)
|> Ash.Changeset.manage_relationship(
  :comments,
  [%{id: 10, rating: 10, contents: "foo"}],
  on_match: {:update, :update_action},
  on_no_match: {:create, :create_action})

This is a simple way to manage a relationship. If you need custom behavior, you can customize the action that is called, which allows you to add arguments/changes. However, at some point you may want to forego this function and make the changes yourself. For example:

input = [%{id: 10, rating: 10, contents: "foo"}]

changeset
|> Ash.Changeset.after_action(fn _changeset, result ->
  # An example of updating comments based on a result of other changes
  for comment <- input do
    comment = MyApi.get(Comment, comment.id)

    comment
    |> Map.update(:rating, 0, &(&1 * result.rating_weight))
    |> MyApi.update!()
  end

  {:ok, result}
end)

Using records as input

Records can be supplied as the input values. If you do:

  • if it would be looked up due to on_lookup, the record is used as-is
  • if it would be created due to on_no_match, the record is used as-is
  • Instead of specifying join_keys, those keys must go in __metadata__.join_keys. If join_keys is specified in the options, it is ignored.

For example:

post1 =
  changeset
  |> Api.create!()
  |> Ash.Resource.put_metadata(:join_keys, %{type: "a"})

post1 =
  changeset2
  |> Api.create!()
  |> Ash.Resource.put_metadata(:join_keys, %{type: "b"})

author = Api.create!(author_changeset)

Ash.Changeset.manage_relationship(
  author,
  :posts,
  [post1, post2],
  on_lookup: :relate
)
Link to this function

manage_relationship_opts(atom)

View Source
@spec manage_relationship_opts(manage_relationship_type()) :: Keyword.t()
Link to this function

new(resource, params \\ %{})

View Source
@spec new(Ash.Resource.t() | Ash.Resource.record(), params :: map()) :: t()

Returns a new changeset over a resource.

Warning: You almost always want to use for_action or for_create, etc. over this function if possible.

You can use this to start a changeset and make a few changes prior to calling for_action. For example:

Resource
|> Ash.Changeset.new()
|> Ash.Changeset.change_attribute(:name, "foobar")
|> Ash.Changeset.for_action(...)
Link to this function

prepare_changeset_for_action(changeset, action, opts)

View Source
Link to this function

present?(changeset, attribute)

View Source

Checks if an attribute is not nil, either in the original data, or that it is not being changed to a nil value if it is changing.

This also accounts for the accessing_from context that is set when using manage_relationship, so it is aware that a particular value will be set by manage_relationship even if it isn't currently being set.

Link to this function

put_context(changeset, key, value)

View Source
@spec put_context(t(), atom(), term()) :: t()

Puts a key/value in the changeset context that can be used later.

Do not use the private key in your custom context, as that is reserved for internal use.

Link to this function

remove_from_relationship(changeset, relationship, record_or_records, opts \\ [])

View Source
This function is deprecated. Use manage_relationship/4 instead.
@spec remove_from_relationship(
  t(),
  atom(),
  Ash.Resource.record()
  | map()
  | term()
  | [Ash.Resource.record() | map() | term()],
  Keyword.t()
) :: t()

Removes a record or a list of records to a relationship.

Alias for:

manage_relationship(changeset, relationship, record_or_records,
  on_no_match: :error, # If a record is not found in the relationship, we error
  on_match: :unrelate, # If a record is found in the relationship we unrelate it
  on_missing: :ignore, # If a record is not found in the relationship
  authorize?: false
)
Link to this function

replace_relationship(changeset, relationship, record_or_records, opts \\ [])

View Source
This function is deprecated. Use manage_relationship/4 instead.
@spec replace_relationship(
  t(),
  atom(),
  Ash.Resource.record()
  | map()
  | term()
  | [Ash.Resource.record() | map() | term()]
  | nil,
  Keyword.t()
) :: t()

Alias for:

manage_relationship(
  changeset,
  relationship,
  record_or_records,
  on_lookup: :relate, # If a record is not found in the relationship, but is found in the database, relate it and apply the input as an update
  on_no_match: :error, # If a record is not found in the relationship or the database, we error
  on_match: :ignore, # If a record is found in the relationship we make no changes to it
  on_missing: :unrelate, # If a record is not found in the relationship, we unrelate it
  authorize?: false
)
Link to this function

run_before_transaction_hooks(changeset)

View Source
Link to this function

select(changeset, fields, opts \\ [])

View Source

Ensure that only the specified attributes are present in the results.

The first call to select/2 will replace the default behavior of selecting all attributes. Subsequent calls to select/2 will combine the provided fields unless the replace? option is provided with a value of true.

If a field has been deselected, selecting it again will override that (because a single list of fields is tracked for selection)

Primary key attributes always selected and cannot be deselected.

When attempting to load a relationship (or manage it with Ash.Changeset.manage_relationship/3), if the source field is not selected on the query/provided data an error will be produced. If loading a relationship with a query, an error is produced if the query does not select the destination field of the relationship.

Datalayers currently are not notified of the select for a changeset(unlike queries), and creates/updates select all fields when they are performed. A select provided on a changeset sets the unselected fields to nil before returning the result.

Use ensure_selected/2 if you wish to make sure a field has been selected, without deselecting any other fields.

Link to this function

selecting?(changeset, field)

View Source
Link to this function

set_argument(changeset, argument, value)

View Source

Add an argument to the changeset, which will be provided to the action.

Link to this function

set_arguments(changeset, map)

View Source

Merge a map of arguments to the arguments list.

Link to this function

set_context(changeset, map)

View Source
@spec set_context(t(), map() | nil) :: t()

Deep merges the provided map into the changeset context that can be used later.

Do not use the private key in your custom context, as that is reserved for internal use.

Link to this function

set_on_upsert(changeset, upsert_keys)

View Source
@spec set_on_upsert(t(), [atom()]) :: Keyword.t()
Link to this function

set_result(changeset, result)

View Source
@spec set_result(t(), term()) :: t()

Set the result of the action. This will prevent running the underlying datalayer behavior

Link to this function

set_tenant(changeset, tenant)

View Source
@spec set_tenant(t(), term()) :: t()
Link to this function

timeout(changeset, timeout, default \\ nil)

View Source
@spec timeout(t(), nil | pos_integer(), nil | pos_integer()) :: t()
Link to this function

with_hooks(changeset, func, opts \\ [])

View Source
@spec with_hooks(
  t(),
  (t() ->
     {:ok, term(), %{notifications: [Ash.Notifier.Notification.t()]}}
     | {:error, term()}),
  Keyword.t()
) ::
  {:ok, term(), t(), %{notifications: [Ash.Notifier.Notification.t()]}}
  | {:error, term()}

Wraps a function in the before/after action hooks of a changeset.

The function takes a changeset and if it returns {:ok, result}, the result will be passed through the after action hooks.