ash v0.1.8 Ash View Source

The primary interface for interrogating apis and resources.

This is not the code level interface for a resource. Instead, call functions on an Api module that contains those resources. This is for retrieving resource/api configurations.

Link to this section Summary

Link to this section Types

Link to this type

attribute()

View Source
attribute() :: Ash.Resource.Attributes.Attribute.t()
Link to this type

cardinality_many_relationship()

View Source
cardinality_many_relationship() ::
  Ash.Resource.Relationships.HasMany.t()
  | Ash.Resource.Relationships.ManyToMany.t()
Link to this type

cardinality_one_relationship()

View Source
cardinality_one_relationship() ::
  Ash.Resource.Relationships.HasOne.t()
  | Ash.Resource.Relationships.BelongsTo.t()
Link to this type

create_params()

View Source
create_params() :: Keyword.t()
Link to this type

data_layer()

View Source
data_layer() :: module()
Link to this type

data_layer_query()

View Source
data_layer_query() :: struct()
Link to this type

delete_params()

View Source
delete_params() :: Keyword.t()
Link to this type

relationship_cardinality()

View Source
relationship_cardinality() :: :many | :one
Link to this type

resource()

View Source
resource() :: module()
Link to this type

side_loads()

View Source
side_loads() :: Keyword.t()
Link to this type

update_params()

View Source
update_params() :: Keyword.t()

Link to this section Functions

Link to this function

action(resource, name, type)

View Source
action(resource(), atom(), atom()) :: action() | nil
Link to this function

actions(resource)

View Source
actions(resource()) :: [action()]
Link to this function

attribute(resource, name)

View Source
attribute(resource(), String.t() | atom()) :: attribute() | nil
Link to this function

attributes(resource)

View Source
attributes(resource()) :: [attribute()]
Link to this function

data_layer(resource)

View Source
data_layer(resource()) :: data_layer()
Link to this function

data_layer_can?(resource, feature)

View Source
data_layer_can?(resource(), Ash.DataLayer.feature()) :: boolean()
Link to this function

data_layer_filters(resource)

View Source
data_layer_filters(resource()) :: map()
Link to this macro

partial_resource(list)

View Source (macro)
Link to this function

primary_action(resource, type)

View Source
primary_action(resource(), atom()) :: action() | nil
Link to this function

primary_action!(resource, type)

View Source
Link to this function

primary_key(resource)

View Source
primary_key(resource()) :: [atom()]
Link to this function

relationship(resource, relationship_name)

View Source
relationship(resource(), atom() | String.t()) :: relationship() | nil
Link to this function

relationships(resource)

View Source
relationships(resource()) :: [relationship()]
Link to this function

resource_module?(module)

View Source
resource_module?(module()) :: boolean()
Link to this function

resources(api)

View Source
resources(api()) :: [resource()]