ash

v0.1.1

ash v0.1.1 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.

Link to this section Summary

Types

action()
api()
attribute()
cardinality_many_relationship()
cardinality_one_relationship()
data_layer()
error()
filter()
query()
record()
relationship()
resource()
side_load_config()
side_loads()
sort()

Functions

action(resource, name, type)
actions(resource)
attribute(resource, name)
attributes(resource)
data_layer(resource)
default_page_size(api, resource)
max_page_size(api, resource)
name(resource)
primary_action(resource, type)
primary_key(resource)
relationship(resource, relationship_name)
relationships(resource)
resources(api)
side_load_config(api)
type(resource)

Link to this section Types

Link to this type

action()

View Source 
action() ::
  Ash.Resource.Actions.Create.t()
  | Ash.Resource.Actions.Read.t()
  | Ash.Resource.Actions.Update.t()
  | Ash.Resource.Actions.Destroy.t()
Link to this type

api()

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

attribute()

View Source 
attribute() :: Ash.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

data_layer()

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

error()

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

filter()

View Source 
filter() :: map()
Link to this type

query()

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

record()

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

relationship()

View Source 
relationship() ::
  cardinality_one_relationship() | cardinality_many_relationship()
Link to this type

resource()

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

side_load_config()

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

side_loads()

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

sort()

View Source 
sort() :: 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

default_page_size(api, resource)

View Source 
default_page_size(api(), resource()) :: non_neg_integer() | nil
Link to this function

max_page_size(api, resource)

View Source 
max_page_size(api(), resource()) :: non_neg_integer() | nil
Link to this function

name(resource)

View Source 
name(resource()) :: String.t()
Link to this function

primary_action(resource, type)

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

primary_key(resource)

View Source 
primary_key(resource()) :: [attribute()]
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

resources(api)

View Source 
resources(api()) :: [resource()]
Link to this function

side_load_config(api)

View Source 
side_load_config(api()) :: side_load_config()
Link to this function

type(resource)

View Source 
type(resource()) :: String.t()