ash v0.4.0 Ash.DataLayer behaviour View Source

The interface for being an ash data layer.

Typically this will be provided by an extension, but you could implement one yourself and add it to your resource with @data_layer YourDataLayer

This is a large behaviour, and this capability is not complete, but the idea is to have a large amount of optional callbacks, and use the can?/2 callback to ensure that the engine only ever tries to interact with the data layer in ways that it supports.

Link to this section Summary

Types

feature()

filter_type()

Functions

can?(feature, resource)

create(resource, changeset)

custom_filters(resource)

filter(query, filter, resource)

limit(query, limit, resource)

offset(query, offset, resource)

resource_to_query(resource)

run_query(query, central_resource)

sort(query, sort, resource)

transact(resource, func)

update(resource, changeset)

upsert(resource, changeset)

Callbacks

can?(arg1, feature)

can_query_async?(arg1)

create(arg1, changeset)

custom_filters(arg1)

destroy(record)

filter(arg1, arg2, resource)

limit(arg1, limit, resource)

offset(arg1, offset, resource)

resource_to_query(arg1)

run_query(arg1, arg2)

sort(arg1, arg2, resource)

transaction(arg1, function)

update(arg1, changeset)

upsert(arg1, changeset)

Link to this section Types

feature()

Specs

feature() ::
  :transact
  | :async_engine
  | {:filter, filter_type()}
  | {:filter_related, Ash.relationship_cardinality()}
  | :upsert
  | :composite_primary_key

filter_type()

Specs

filter_type() :: :eq | :in

Link to this section Functions

can?(feature, resource)

Specs

can?(feature(), Ash.resource()) :: boolean()

create(resource, changeset)

Specs

create(Ash.resource(), Ecto.Changeset.t()) ::
  {:ok, Ash.record()} | {:error, term()}

custom_filters(resource)

filter(query, filter, resource)

Specs

filter(Ash.data_layer_query(), Ash.filter(), Ash.resource()) ::
  {:ok, Ash.data_layer_query()} | {:error, term()}

limit(query, limit, resource)

Specs

limit(Ash.data_layer_query(), limit :: non_neg_integer(), Ash.resource()) ::
  {:ok, Ash.data_layer_query()} | {:error, term()}

offset(query, offset, resource)

Specs

offset(Ash.data_layer_query(), offset :: non_neg_integer(), Ash.resource()) ::
  {:ok, Ash.data_layer_query()} | {:error, term()}

resource_to_query(resource)

Specs

resource_to_query(Ash.resource()) :: Ash.data_layer_query()

run_query(query, central_resource)

Specs

run_query(Ash.data_layer_query(), central_resource :: Ash.resource()) ::
  {:ok, [Ash.record()]} | {:error, term()}

sort(query, sort, resource)

Specs

sort(Ash.data_layer_query(), Ash.sort(), Ash.resource()) ::
  {:ok, Ash.data_layer_query()} | {:error, term()}

transact(resource, func)

update(resource, changeset)

Specs

update(Ash.resource(), Ecto.Changeset.t()) ::
  {:ok, Ash.record()} | {:error, term()}

upsert(resource, changeset)

Specs

upsert(Ash.resource(), Ecto.Changeset.t()) ::
  {:ok, Ash.record()} | {:error, term()}

Link to this section Callbacks

can?(arg1, feature)

Specs

can?(Ash.resource(), feature()) :: boolean()

can_query_async?(arg1)

Specs

can_query_async?(Ash.resource()) :: boolean()

create(arg1, changeset)

Specs

create(Ash.resource(), changeset :: Ecto.Changeset.t()) ::
  {:ok, Ash.resource()} | {:error, term()}

custom_filters(arg1)

(optional)

Specs

custom_filters(Ash.resource()) :: map()

destroy(record)

Specs

destroy(record :: Ash.record()) :: :ok | {:error, term()}

filter(arg1, arg2, resource)

Specs

filter(Ash.data_layer_query(), Ash.filter(), resource :: Ash.resource()) ::
  {:ok, Ash.data_layer_query()} | {:error, term()}

limit(arg1, limit, resource)

Specs

limit(
  Ash.data_layer_query(),
  limit :: non_neg_integer(),
  resource :: Ash.resource()
) :: {:ok, Ash.data_layer_query()} | {:error, term()}

offset(arg1, offset, resource)

Specs

offset(
  Ash.data_layer_query(),
  offset :: non_neg_integer(),
  resource :: Ash.resource()
) :: {:ok, Ash.data_layer_query()} | {:error, term()}

resource_to_query(arg1)

Specs

resource_to_query(Ash.resource()) :: Ash.data_layer_query()

run_query(arg1, arg2)

Specs

run_query(Ash.data_layer_query(), Ash.resource()) ::
  {:ok, [Ash.resource()]} | {:error, term()}

sort(arg1, arg2, resource)

Specs

sort(Ash.data_layer_query(), Ash.sort(), resource :: Ash.resource()) ::
  {:ok, Ash.data_layer_query()} | {:error, term()}

transaction(arg1, function)

(optional)

Specs

transaction(Ash.resource(), (() -> term())) :: {:ok, term()} | {:error, term()}

update(arg1, changeset)

Specs

update(Ash.resource(), changeset :: Ecto.Changeset.t()) ::
  {:ok, Ash.resource()} | {:error, term()}

upsert(arg1, changeset)

(optional)

Specs

upsert(Ash.resource(), changeset :: Ecto.Changeset.t()) ::
  {:ok, Ash.resource()} | {:error, term()}