Specs
primary_action(Ash.Resource.t(), Ash.Resource.Actions.action_type()) :: Ash.Resource.Actions.action() | nil
Returns the primary action of a given type
Ash.Resource.Info (ash v1.37.2) View Source
Introspection for resources
Link to this section Summary
Functions
Returns the action with the matching name and type on the resource
Returns all actions of a resource
Get an aggregate by name
Returns all aggregates of a resource
Get an attribute name from the resource
Returns all attributes of a resource
A list of authorizers to be used when accessing
Get a calculation by name
Returns all calculations of a resource
Returns the configured default actions
A list of identities for the resource
Get the multitenancy strategy for a resource
A list of notifiers to be used when accessing
Returns the primary action of a given type
Returns the primary action of the given type
A list of field names corresponding to the primary key
Get an aggregate by name
Returns all public aggregates of a resource
Get a public attribute name from the resource
Returns all public attributes of a resource
Get a public calculation by name
Returns all public calculations of a resource
Get a public relationship by name or path
Returns all public relationships of a resource
Get a relationship by name or path
Returns all relationships of a resource
Whether or not a given module is a resource module
A list of all validations for the resource
Link to this section Functions
Specs
action(Ash.Resource.t(), atom(), Ash.Resource.Actions.action_type() | nil) :: Ash.Resource.Actions.action() | nil
Returns the action with the matching name and type on the resource
Specs
actions(Ash.Resource.t()) :: [Ash.Resource.Actions.action()]
Returns all actions of a resource
Specs
aggregate(Ash.Resource.t(), atom() | String.t()) :: Ash.Resource.Aggregate.t() | nil
Get an aggregate by name
Specs
aggregates(Ash.Resource.t()) :: [Ash.Resource.Aggregate.t()]
Returns all aggregates of a resource
Specs
attribute(Ash.Resource.t(), String.t() | atom()) :: Ash.Resource.Attribute.t() | nil
Get an attribute name from the resource
Specs
attributes(Ash.Resource.t()) :: [Ash.Resource.Attribute.t()]
Returns all attributes of a resource
Specs
authorizers(Ash.Resource.t()) :: [module()]
A list of authorizers to be used when accessing
Specs
base_filter(Ash.Resource.t()) :: term()
Specs
calculation(Ash.Resource.t(), atom() | String.t()) :: Ash.Resource.Calculation.t() | nil
Get a calculation by name
Specs
calculations(Ash.Resource.t()) :: [Ash.Resource.Calculation.t()]
Returns all calculations of a resource
Specs
default_actions(Ash.Resource.t()) :: [:create | :read | :update | :destroy]
Returns the configured default actions
Specs
default_context(Ash.Resource.t()) :: term()
Specs
description(Ash.Resource.t()) :: String.t() | nil
Specs
embedded?(Ash.Resource.t()) :: boolean()
Specs
extensions(Ash.Resource.t()) :: [module()]
Specs
get_metadata(Ash.Resource.record(), atom() | [atom()]) :: term()
Specs
identities(Ash.Resource.t()) :: [Ash.Resource.Identity.t()]
A list of identities for the resource
Specs
interfaces(Ash.Resource.t()) :: [Ash.Resource.Interface.t()]
Specs
multitenancy_attribute(Ash.Resource.t()) :: atom() | nil
Specs
multitenancy_global?(Ash.Resource.t()) :: atom() | nil
Specs
multitenancy_parse_attribute(Ash.Resource.t()) :: {atom(), atom(), [any()]}
Specs
multitenancy_source(Ash.Resource.t()) :: atom() | nil
Specs
multitenancy_strategy(Ash.Resource.t()) :: :context | :attribute | nil
Get the multitenancy strategy for a resource
Specs
multitenancy_template(Ash.Resource.t()) :: atom() | nil
Specs
notifiers(Ash.Resource.t()) :: [module()]
A list of notifiers to be used when accessing
Specs
primary_action!(Ash.Resource.t(), Ash.Resource.Actions.action_type()) :: Ash.Resource.Actions.action() | no_return()
Returns the primary action of the given type
Specs
primary_key(Ash.Resource.t()) :: [atom()]
A list of field names corresponding to the primary key
Specs
public_aggregate(Ash.Resource.t(), atom() | String.t()) :: Ash.Resource.Aggregate.t() | nil
Get an aggregate by name
Specs
public_aggregates(Ash.Resource.t()) :: [Ash.Resource.Aggregate.t()]
Returns all public aggregates of a resource
Specs
public_attribute(Ash.Resource.t(), String.t() | atom()) :: Ash.Resource.Attribute.t() | nil
Get a public attribute name from the resource
Specs
public_attributes(Ash.Resource.t()) :: [Ash.Resource.Attribute.t()]
Returns all public attributes of a resource
Specs
public_calculation(Ash.Resource.t(), atom() | String.t()) :: Ash.Resource.Calculation.t() | nil
Get a public calculation by name
Specs
public_calculations(Ash.Resource.t()) :: [Ash.Resource.Calculation.t()]
Returns all public calculations of a resource
Get a public relationship by name or path
Specs
public_relationships(Ash.Resource.t()) :: [ Ash.Resource.Relationships.relationship() ]
Returns all public relationships of a resource
Specs
put_metadata(Ash.Resource.record(), atom(), term()) :: Ash.Resource.record()
Specs
relationship(Ash.Resource.t(), atom() | String.t() | [atom() | String.t()]) :: Ash.Resource.Relationships.relationship() | nil
Get a relationship by name or path
Specs
relationships(Ash.Resource.t()) :: [Ash.Resource.Relationships.relationship()]
Returns all relationships of a resource
Specs
Whether or not a given module is a resource module
Specs
selected?(Ash.Resource.record(), atom()) :: boolean()
Specs
set_metadata(Ash.Resource.record(), map()) :: Ash.Resource.record()
Specs
validations(Ash.Resource.t()) :: [Ash.Resource.Validation.t()]
A list of all validations for the resource
Specs
validations(Ash.Resource.t(), :create | :update | :destroy) :: [ Ash.Resource.Validation.t() ]