ash v1.29.0-rc1 Ash.DataLayer behaviour View Source

The interface for being an ash data layer.

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()

Functions

add_aggregate(query, aggregate, resource)

can?(feature, resource)

create(resource, changeset)

destroy(resource, changeset)

filter(query, filter, resource)

functions(resource)

in_transaction?(resource)

limit(query, limit, resource)

offset(query, offset, resource)

resource_to_query(resource, api)

run_aggregate_query(query, aggregates, resource)

run_aggregate_query_with_lateral_join(query, aggregates, root_data, source_resource, destination_resource, source, destination)

run_query(query, central_resource)

run_query_with_lateral_join(query, root_data, source_resource, destination_resource, source, destination)

set_context(resource, query, map)

set_tenant(resource, query, term)

sort(query, sort, resource)

source(resource)

transact(resource, func)

transform_query(query)

update(resource, changeset)

upsert(resource, changeset)

Callbacks

add_aggregate(arg1, arg2, arg3)

can?(arg1, feature)

create(arg1, arg2)

destroy(arg1, arg2)

equal?(arg1)

filter(arg1, arg2, resource)

functions(arg1)

in_transaction?(arg1)

limit(arg1, limit, resource)

offset(arg1, offset, resource)

operators(arg1)

resource_to_query(arg1, arg2)

rollback(arg1, term)

run_aggregate_query(arg1, list, arg3)

run_aggregate_query_with_lateral_join(arg1, list, list, source_resource, destination_resource, source, destination)

run_query(arg1, arg2)

run_query_with_lateral_join(arg1, list, source_resource, destination_resource, source, destination)

set_context(arg1, arg2, map)

set_tenant(arg1, arg2, term)

sort(arg1, arg2, resource)

source(arg1)

transaction(arg1, function)

transform_query(arg1)

update(arg1, arg2)

upsert(arg1, arg2)

Link to this section Types

feature()

Specs

feature() ::
  :transact
  | :multitenant
  | {:lateral_join, Ash.resource()}
  | {:join, Ash.resource()}
  | {:aggregate, Ash.aggregate_kind()}
  | {:query_aggregate, Ash.aggregate_kind()}
  | :aggregate_filter
  | :aggregate_sort
  | :boolean_filter
  | :async_engine
  | :create
  | :read
  | :update
  | :destroy
  | :limit
  | :offset
  | :transact
  | :filter
  | {:filter_expr, struct()}
  | :sort
  | {:sort, Ash.Type.t()}
  | :upsert
  | :composite_primary_key

Link to this section Functions

add_aggregate(query, aggregate, resource)

Specs

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

can?(feature, resource)

Specs

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

create(resource, changeset)

Specs

create(Ash.resource(), Ash.changeset()) ::
  {:ok, Ash.record()} | {:error, term()}

destroy(resource, changeset)

Specs

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

filter(query, filter, resource)

Specs

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

functions(resource)

in_transaction?(resource)

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, api)

Specs

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

run_aggregate_query(query, aggregates, resource)

Specs

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

run_aggregate_query_with_lateral_join(query, aggregates, root_data, source_resource, destination_resource, source, destination)

run_query(query, central_resource)

Specs

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

run_query_with_lateral_join(query, root_data, source_resource, destination_resource, source, destination)

set_context(resource, query, map)

Specs

set_context(Ash.resource(), Ash.data_layer_query(), map()) ::
  Ash.data_layer_query()

set_tenant(resource, query, term)

Specs

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

sort(query, sort, resource)

Specs

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

source(resource)

Specs

source(Ash.resource()) :: String.t()

transact(resource, func)

transform_query(query)

update(resource, changeset)

Specs

update(Ash.resource(), Ash.changeset()) ::
  {:ok, Ash.record()} | {:error, term()}

upsert(resource, changeset)

Specs

upsert(Ash.resource(), Ash.changeset()) ::
  {:ok, Ash.record()} | {:error, term()}

Link to this section Callbacks

add_aggregate(arg1, arg2, arg3)

(optional)

Specs

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

can?(arg1, feature)

Specs

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

create(arg1, arg2)

(optional)

Specs

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

destroy(arg1, arg2)

(optional)

Specs

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

equal?(arg1)

(optional)

Specs

equal?(Ash.data_layer()) :: boolean()

filter(arg1, arg2, resource)

(optional)

Specs

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

functions(arg1)

(optional)

Specs

functions(Ash.resource()) :: [module()]

in_transaction?(arg1)

(optional)

Specs

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

limit(arg1, limit, resource)

(optional)

Specs

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

offset(arg1, offset, resource)

(optional)

Specs

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

operators(arg1)

(optional)

Specs

operators(Ash.resource()) :: [module()]

resource_to_query(arg1, arg2)

(optional)

Specs

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

rollback(arg1, term)

(optional)

Specs

rollback(Ash.resource(), term()) :: no_return()

run_aggregate_query(arg1, list, arg3)

(optional)

Specs

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

run_aggregate_query_with_lateral_join(arg1, list, list, source_resource, destination_resource, source, destination)

(optional)

Specs

run_aggregate_query_with_lateral_join(
  Ash.data_layer_query(),
  [Ash.aggregate()],
  [Ash.record()],
  source_resource :: Ash.resource(),
  destination_resource :: Ash.resource(),
  source :: atom(),
  destination :: atom()
) :: {:ok, [Ash.resource()]} | {:error, term()}

run_query(arg1, arg2)

(optional)

Specs

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

run_query_with_lateral_join(arg1, list, source_resource, destination_resource, source, destination)

(optional)

Specs

run_query_with_lateral_join(
  Ash.data_layer_query(),
  [Ash.record()],
  source_resource :: Ash.resource(),
  destination_resource :: Ash.resource(),
  source :: atom(),
  destination :: atom()
) :: {:ok, [Ash.resource()]} | {:error, term()}

set_context(arg1, arg2, map)

(optional)

Specs

set_context(Ash.resource(), Ash.data_layer_query(), map()) ::
  Ash.data_layer_query()

set_tenant(arg1, arg2, term)

(optional)

Specs

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

sort(arg1, arg2, resource)

(optional)

Specs

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

source(arg1)

(optional)

Specs

source(Ash.resource()) :: String.t()

transaction(arg1, function)

(optional)

Specs

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

transform_query(arg1)

(optional)

Specs

transform_query(Ash.query()) :: Ash.query()

update(arg1, arg2)

(optional)

Specs

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

upsert(arg1, arg2)

(optional)

Specs

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