Specs
primary_action(Ash.resource(), Ash.action_type()) :: Ash.action() | nil
Returns the primary action of a given type
ash v1.24.1 Ash.Resource View Source
A resource is a static definition of an entity in your system.
Resource DSL documentation: Ash.Resource.Dsl
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
The data layer of the resource, or nil if it does not have one
Whether or not the data layer supports a specific feature
Custom functions supported by the data layer of the resource
Custom operators supported by the data layer of the resource
A list of identities for the resource
Whether or not the data layer for the resource is currently in a transaction
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
Rolls back the current transaction
Wraps the execution of the function in a transaction with the resource's data_layer
A list of all validations for the resource
Link to this section Functions
Specs
action(Ash.resource(), atom(), Ash.action_type()) :: Ash.action() | nil
Returns the action with the matching name and type on the resource
Specs
actions(Ash.resource()) :: [Ash.action()]
Returns all actions of a resource
Specs
aggregate(Ash.resource(), atom() | String.t()) :: Ash.aggregate() | nil
Get an aggregate by name
Specs
aggregates(Ash.resource()) :: [Ash.aggregate()]
Returns all aggregates of a resource
Specs
attribute(Ash.resource(), String.t() | atom()) :: Ash.attribute() | nil
Get an attribute name from the resource
Specs
attributes(Ash.resource()) :: [Ash.attribute()]
Returns all attributes of a resource
Specs
authorizers(Ash.resource()) :: [module()]
A list of authorizers to be used when accessing
Specs
base_filter(Ash.resource()) :: term()
Specs
calculation(Ash.resource(), atom() | String.t()) :: Ash.calculation() | nil
Get a calculation by name
Specs
calculations(Ash.resource()) :: [Ash.calculation()]
Returns all calculations of a resource
Specs
data_layer(Ash.resource()) :: Ash.data_layer()
The data layer of the resource, or nil if it does not have one
Specs
data_layer_can?(Ash.resource(), Ash.DataLayer.feature()) :: boolean()
Whether or not the data layer supports a specific feature
Specs
data_layer_functions(Ash.resource()) :: map()
Custom functions supported by the data layer of the resource
Specs
data_layer_operators(Ash.resource()) :: map()
Custom operators supported by the data layer of the resource
Specs
description(Ash.resource()) :: String.t() | nil
Specs
identities(Ash.resource()) :: [Ash.Resource.Identity.t()]
A list of identities for the resource
Specs
in_transaction?(Ash.resource()) :: boolean()
Whether or not the data layer for the resource is currently in a transaction
Specs
multitenancy_attribute(Ash.resource()) :: atom() | nil
Specs
multitenancy_global?(Ash.resource()) :: atom() | nil
Specs
multitenancy_parse_attribute(Ash.resource()) :: {atom(), atom(), [any()]}
Specs
multitenancy_source(Ash.resource()) :: atom() | nil
Specs
multitenancy_strategy(Ash.resource()) :: :context | :attribute | nil
Get the multitenancy strategy for a resource
Specs
multitenancy_template(Ash.resource()) :: atom() | nil
Specs
notifiers(Ash.resource()) :: [module()]
A list of notifiers to be used when accessing
Specs
primary_action!(Ash.resource(), Ash.action_type()) :: Ash.action() | no_return()
Returns the primary action of the given type
Specs
primary_key(Ash.resource()) :: [atom()]
A list of field names corresponding to the primary key
Specs
public_aggregate(Ash.resource(), atom() | String.t()) :: Ash.aggregate() | nil
Get an aggregate by name
Specs
public_aggregates(Ash.resource()) :: [Ash.aggregate()]
Returns all public aggregates of a resource
Specs
public_attribute(Ash.resource(), String.t() | atom()) :: Ash.attribute() | nil
Get a public attribute name from the resource
Specs
public_attributes(Ash.resource()) :: [Ash.attribute()]
Returns all public attributes of a resource
Specs
public_calculation(Ash.resource(), atom() | String.t()) :: Ash.calculation() | nil
Get a public calculation by name
Specs
public_calculations(Ash.resource()) :: [Ash.calculation()]
Returns all public calculations of a resource
Get a public relationship by name or path
Specs
public_relationships(Ash.resource()) :: [Ash.relationship()]
Returns all public relationships of a resource
Specs
relationship(Ash.resource(), atom() | String.t() | [atom() | String.t()]) :: Ash.relationship() | nil
Get a relationship by name or path
Specs
relationships(Ash.resource()) :: [Ash.relationship()]
Returns all relationships of a resource
Specs
Whether or not a given module is a resource module
Specs
rollback(Ash.resource(), term()) :: no_return()
Rolls back the current transaction
Specs
transaction(Ash.resource(), (() -> term())) :: term()
Wraps the execution of the function in a transaction with the resource's data_layer
Specs
validations(Ash.resource()) :: [Ash.validation()]
A list of all validations for the resource
Specs
validations(Ash.resource(), :create | :update | :destroy) :: [Ash.validation()]