Ash.DataLayer behaviour (ash v1.46.8) 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

data_layer_query()

feature()

lateral_join_link()

t()

Functions

add_aggregate(query, aggregate, resource)

add_calculation(query, calculation, expression, resource)

can?(feature, resource)

create(resource, changeset)

data_layer(resource)

The data layer of the resource, or nil if it does not have one

data_layer_can?(resource, feature)

Whether or not the data layer supports a specific feature

data_layer_functions(resource)

Custom functions supported by the data layer of the resource

destroy(resource, changeset)

distinct(query, distinct, resource)

filter(query, filter, resource)

functions(resource)

in_transaction?(resource)

limit(query, limit, resource)

offset(query, offset, resource)

resource_to_query(resource, api)

rollback(resource, term)

Rolls back the current transaction

run_aggregate_query(query, aggregates, resource)

run_aggregate_query_with_lateral_join(query, aggregates, root_data, destination_resource, path)

run_query(query, central_resource)

run_query_with_lateral_join(query, root_data, destination_resource, path)

select(query, select, resource)

set_context(resource, query, map)

set_tenant(resource, query, term)

sort(query, sort, resource)

source(resource)

transact(resource, func)

transaction(resource, func)

Wraps the execution of the function in a transaction with the resource's data_layer

transform_query(query)

update(resource, changeset)

upsert(resource, changeset, keys)

Callbacks

add_aggregate(data_layer_query, arg2, arg3)

add_calculation(data_layer_query, arg2, expression, arg4)

can?(arg1, feature)

create(arg1, arg2)

destroy(arg1, arg2)

distinct(data_layer_query, list, resource)

filter(data_layer_query, arg2, resource)

functions(arg1)

in_transaction?(arg1)

limit(data_layer_query, limit, resource)

offset(data_layer_query, offset, resource)

operators(arg1)

resource_to_query(arg1, arg2)

rollback(arg1, term)

run_aggregate_query(data_layer_query, list, arg3)

run_aggregate_query_with_lateral_join(data_layer_query, list, list, destination_resource, list)

run_query(data_layer_query, arg2)

run_query_with_lateral_join(data_layer_query, list, source_resource, list)

select(data_layer_query, select, resource)

set_context(data_layer_query, map)

set_context(arg1, data_layer_query, map)

set_tenant(arg1, data_layer_query, term)

sort(data_layer_query, arg2, resource)

source(arg1)

transaction(arg1, function)

transform_query(arg1)

update(arg1, arg2)

upsert(arg1, arg2, list)

Link to this section Types

data_layer_query()

Specs

data_layer_query() :: struct()

feature()

Specs

feature() ::
  :transact
  | :multitenant
  | {:lateral_join, [Ash.Resource.t()]}
  | {:join, Ash.Resource.t()}
  | {:aggregate, Ash.Query.Aggregate.kind()}
  | {:query_aggregate, Ash.Query.Aggregate.kind()}
  | :select
  | :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

lateral_join_link()

Specs

lateral_join_link() ::
  {Ash.Resource.t(), atom(), atom(), Ash.Resource.Relationships.relationship()}

t()

Specs

t() :: module()

Link to this section Functions

add_aggregate(query, aggregate, resource)

Specs

add_aggregate(data_layer_query(), Ash.Query.Aggregate.t(), Ash.Resource.t()) ::
  {:ok, data_layer_query()} | {:error, term()}

add_calculation(query, calculation, expression, resource)

Specs

add_calculation(
  data_layer_query(),
  Ash.Query.Calculation.t(),
  expression :: term(),
  Ash.Resource.t()
) :: {:ok, data_layer_query()} | {:error, term()}

can?(feature, resource)

Specs

can?(feature(), Ash.Resource.t()) :: boolean()

create(resource, changeset)

Specs

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

data_layer(resource)

Specs

data_layer(Ash.Resource.t()) :: t()

The data layer of the resource, or nil if it does not have one

data_layer_can?(resource, feature)

Specs

data_layer_can?(Ash.Resource.t(), feature()) :: boolean()

Whether or not the data layer supports a specific feature

data_layer_functions(resource)

Specs

data_layer_functions(Ash.Resource.t()) :: map()

Custom functions supported by the data layer of the resource

destroy(resource, changeset)

Specs

destroy(Ash.Resource.t(), Ash.Changeset.t()) :: :ok | {:error, term()}

distinct(query, distinct, resource)

Specs

distinct(data_layer_query(), [atom()] | nil, Ash.Resource.t()) ::
  {:ok, data_layer_query()} | {:error, term()}

filter(query, filter, resource)

Specs

filter(data_layer_query(), Ash.Filter.t(), Ash.Resource.t()) ::
  {:ok, data_layer_query()} | {:error, term()}

functions(resource)

in_transaction?(resource)

limit(query, limit, resource)

Specs

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

offset(query, offset, resource)

Specs

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

resource_to_query(resource, api)

Specs

resource_to_query(Ash.Resource.t(), Ash.Api.t()) :: data_layer_query()

rollback(resource, term)

Specs

rollback(Ash.Resource.t(), term()) :: no_return()

Rolls back the current transaction

run_aggregate_query(query, aggregates, resource)

Specs

run_aggregate_query(
  data_layer_query(),
  [Ash.Query.Aggregate.t()],
  Ash.Resource.t()
) :: {:ok, map()} | {:error, term()}

run_aggregate_query_with_lateral_join(query, aggregates, root_data, destination_resource, path)

run_query(query, central_resource)

Specs

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

run_query_with_lateral_join(query, root_data, destination_resource, path)

select(query, select, resource)

Specs

select(data_layer_query(), offset :: [atom()], Ash.Resource.t()) ::
  {:ok, data_layer_query()} | {:error, term()}

set_context(resource, query, map)

Specs

set_context(Ash.Resource.t(), data_layer_query(), map()) ::
  {:ok, data_layer_query()} | {:error, term()}

set_tenant(resource, query, term)

Specs

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

sort(query, sort, resource)

Specs

sort(data_layer_query(), Ash.Sort.t(), Ash.Resource.t()) ::
  {:ok, data_layer_query()} | {:error, term()}

source(resource)

Specs

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

transact(resource, func)

transaction(resource, func)

Specs

transaction(Ash.Resource.t(), (() -> term())) :: term()

Wraps the execution of the function in a transaction with the resource's data_layer

transform_query(query)

update(resource, changeset)

Specs

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

upsert(resource, changeset, keys)

Specs

upsert(Ash.Resource.t(), Ash.Changeset.t(), [atom()]) ::
  {:ok, Ash.Resource.record()} | {:error, term()}

Link to this section Callbacks

add_aggregate(data_layer_query, arg2, arg3)

(optional)

Specs

add_aggregate(data_layer_query(), Ash.Query.Aggregate.t(), Ash.Resource.t()) ::
  {:ok, data_layer_query()} | {:error, term()}

add_calculation(data_layer_query, arg2, expression, arg4)

(optional)

Specs

add_calculation(
  data_layer_query(),
  Ash.Query.Calculation.t(),
  expression :: any(),
  Ash.Resource.t()
) :: {:ok, data_layer_query()} | {:error, term()}

can?(arg1, feature)

Specs

can?(Ash.Resource.t(), feature()) :: boolean()

create(arg1, arg2)

(optional)

Specs

create(Ash.Resource.t(), Ash.Changeset.t()) ::
  {:ok, Ash.Resource.t()} | {:error, term()}

destroy(arg1, arg2)

(optional)

Specs

destroy(Ash.Resource.t(), Ash.Changeset.t()) :: :ok | {:error, term()}

distinct(data_layer_query, list, resource)

(optional)

Specs

distinct(data_layer_query(), [atom()], resource :: Ash.Resource.t()) ::
  {:ok, data_layer_query()} | {:error, term()}

filter(data_layer_query, arg2, resource)

(optional)

Specs

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

functions(arg1)

(optional)

Specs

functions(Ash.Resource.t()) :: [module()]

in_transaction?(arg1)

(optional)

Specs

in_transaction?(Ash.Resource.t()) :: boolean()

limit(data_layer_query, limit, resource)

(optional)

Specs

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

offset(data_layer_query, offset, resource)

(optional)

Specs

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

operators(arg1)

(optional)

Specs

operators(Ash.Resource.t()) :: [module()]

resource_to_query(arg1, arg2)

(optional)

Specs

resource_to_query(Ash.Resource.t(), Ash.Api.t()) :: data_layer_query()

rollback(arg1, term)

(optional)

Specs

rollback(Ash.Resource.t(), term()) :: no_return()

run_aggregate_query(data_layer_query, list, arg3)

(optional)

Specs

run_aggregate_query(
  data_layer_query(),
  [Ash.Query.Aggregate.t()],
  Ash.Resource.t()
) :: {:ok, map()} | {:error, term()}

run_aggregate_query_with_lateral_join(data_layer_query, list, list, destination_resource, list)

(optional)

Specs

run_aggregate_query_with_lateral_join(
  data_layer_query(),
  [Ash.Query.Aggregate.t()],
  [Ash.Resource.record()],
  destination_resource :: Ash.Resource.t(),
  [lateral_join_link()]
) :: {:ok, [Ash.Resource.t()]} | {:error, term()}

run_query(data_layer_query, arg2)

(optional)

Specs

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

run_query_with_lateral_join(data_layer_query, list, source_resource, list)

(optional)

Specs

run_query_with_lateral_join(
  data_layer_query(),
  [Ash.Resource.record()],
  source_resource :: Ash.Resource.t(),
  [lateral_join_link()]
) :: {:ok, [Ash.Resource.t()]} | {:error, term()}

select(data_layer_query, select, resource)

(optional)

Specs

select(data_layer_query(), select :: [atom()], resource :: Ash.Resource.t()) ::
  {:ok, data_layer_query()} | {:error, term()}

set_context(data_layer_query, map)

(optional)

Specs

set_context(data_layer_query(), map()) ::
  {:ok, data_layer_query()} | {:error, term()}

set_context(arg1, data_layer_query, map)

(optional)

Specs

set_context(Ash.Resource.t(), data_layer_query(), map()) ::
  {:ok, data_layer_query()} | {:error, term()}

set_tenant(arg1, data_layer_query, term)

(optional)

Specs

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

sort(data_layer_query, arg2, resource)

(optional)

Specs

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

source(arg1)

(optional)

Specs

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

transaction(arg1, function)

(optional)

Specs

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

transform_query(arg1)

(optional)

Specs

transform_query(Ash.Query.t()) :: Ash.Query.t()

update(arg1, arg2)

(optional)

Specs

update(Ash.Resource.t(), Ash.Changeset.t()) ::
  {:ok, Ash.Resource.t()} | {:error, term()}

upsert(arg1, arg2, list)

(optional)

Specs

upsert(Ash.Resource.t(), Ash.Changeset.t(), [atom()]) ::
  {:ok, Ash.Resource.t()} | {:error, term()}