View Source Ash.Resource.Validation behaviour (ash v2.19.3)

Represents a validation in Ash.

See Ash.Resource.Validation.Builtins for a list of builtin validations.

To write your own validation, define a module that implements the init/1 callback to validate options at compile time, and validate/2 callback to do the validation.

Then, in a resource, you can say:

validations do
  validate {MyValidation, [foo: :bar]}
end

Summary

Types

context()

path()

ref()

t()

Callbacks

atomic(changeset, opts)

atomic?()

describe(opts)

has_validate?()

init(opts)

validate(changeset, opts)

validate(changeset, opts, context)

Functions

action_schema()

opt_schema()

validation_type()

Types

context()

@type context() :: %{
  optional(:actor) => Ash.Resource.record() | nil,
  optional(:tenant) => term(),
  optional(:authorize?) => boolean() | nil,
  optional(:tracer) => Ash.Tracer.t() | [Ash.Tracer.t()] | nil,
  optional(any()) => any()
}

path()

@type path() :: [atom() | integer()]

ref()

@type ref() :: {module(), Keyword.t()} | module()

t()

@type t() :: %Ash.Resource.Validation{
  always_atomic?: term(),
  before_action?: term(),
  description: String.t() | nil,
  message: term(),
  module: atom(),
  on: [atom()],
  only_when_valid?: boolean(),
  opts: [atom()],
  validation: {atom(), [atom()]},
  where: [{atom(), [atom()]}]
}

Callbacks

atomic(changeset, opts)

(optional)

@callback atomic(changeset :: Ash.Changeset.t(), opts :: Keyword.t()) ::
  :ok
  | {:atomic, involved_fields :: [atom()] | :*, condition_expr :: Ash.Expr.t(),
     error_expr :: Ash.Expr.t()}
  | [
      {:atomic, involved_fields :: [atom()] | :*,
       condition_expr :: Ash.Expr.t(), error_expr :: Ash.Expr.t()}
    ]
  | {:not_atomic, String.t()}
  | {:error, term()}

atomic?()

@callback atomic?() :: boolean()

describe(opts)

(optional)

@callback describe(opts :: Keyword.t()) ::
  String.t() | [message: String.t(), vars: Keyword.t()]

has_validate?()

@callback has_validate?() :: boolean()

init(opts)

@callback init(opts :: Keyword.t()) :: {:ok, Keyword.t()} | {:error, String.t()}

validate(changeset, opts)

(optional)

@callback validate(changeset :: Ash.Changeset.t(), opts :: Keyword.t()) ::
  :ok | {:error, term()}

validate(changeset, opts, context)

(optional)

@callback validate(
  changeset :: Ash.Changeset.t(),
  opts :: Keyword.t(),
  context :: context()
) ::
  :ok | {:error, term()}