View Source Ash.DataLayer behaviour (ash v2.9.24)

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

bulk_options()

data_layer_query()

feature()

lateral_join_link()

lock_type()

t()

transaction_reason()

Callbacks

add_aggregate( data_layer_query, t, t )

add_aggregates( data_layer_query, list, t )

add_calculation( data_layer_query, t, expression, t )

add_calculations( data_layer_query, list, t )

bulk_create( t, t, options )

can?(arg1, feature)

create(t, t)

destroy(t, t)

distinct(data_layer_query, list, resource)

filter(data_layer_query, t, resource)

functions(t)

in_transaction?(t)

limit( data_layer_query, limit, resource )

lock(data_layer_query, lock_type, resource)

offset( data_layer_query, offset, resource )

resource_to_query(t, t)

rollback(t, term)

run_aggregate_query( data_layer_query, list, t )

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

run_query(data_layer_query, t)

run_query_with_lateral_join( data_layer_query, list, source_resource, list )

select( data_layer_query, select, resource )

set_context(t, data_layer_query, map)

set_tenant(t, data_layer_query, term)

sort(data_layer_query, t, resource)

source(t)

transaction( t, function, arg3, reason )

transform_query(t)

update(t, t)

upsert(t, t, list)

Functions

add_aggregates(query, aggregates, resource)

add_calculations(query, calculations, resource)

bulk_create(resource, changesets, options)

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)

lock(query, lock_type, 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)

transaction(resource_or_resources, func, timeout \\ nil, reason \\ %{type: :custom, metadata: %{}})

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)

Link to this section Types

bulk_options()

@type bulk_options() :: %{
  batch_size: pos_integer(),
  return_records?: boolean(),
  upsert?: boolean(),
  upsert_keys: nil | [atom()],
  upsert_fields: nil | [atom()],
  tenant: String.t() | nil
}

data_layer_query()

@type data_layer_query() :: struct()

feature()

@type feature() ::
  :transact
  | :multitenancy
  | {:lateral_join, [Ash.Resource.t()]}
  | {:join, Ash.Resource.t()}
  | {:aggregate, Ash.Query.Aggregate.kind()}
  | {:aggregate_relationship, Ash.Resource.Relationships.relationship()}
  | {:query_aggregate, Ash.Query.Aggregate.kind()}
  | :select
  | :aggregate_filter
  | :aggregate_sort
  | :boolean_filter
  | :async_engine
  | :create
  | :read
  | :update
  | :destroy
  | :limit
  | :offset
  | :transact
  | :filter
  | {:lock, lock_type()}
  | {:filter_expr, struct()}
  | {:filter_relationship, Ash.Resource.Relationships.relationship()}
  | :sort
  | {:sort, Ash.Type.t()}
  | :upsert
  | :composite_primary_key

lateral_join_link()

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

lock_type()

@type lock_type() :: :for_update | term()

t()

@type t() :: module()

transaction_reason()

@type transaction_reason() ::
  %{type: :create, metadata: %{resource: Ash.Resource.t(), action: atom()}}
  | %{
      type: :update,
      metadata: %{
        resource: Ash.Resource.t(),
        action: atom(),
        record: Ash.Resource.record(),
        actor: term()
      }
    }
  | %{
      type: :destroy,
      metadata: %{
        resource: Ash.Resource.t(),
        action: atom(),
        record: Ash.Resource.record(),
        actor: term()
      }
    }
  | %{
      type: :read,
      metadata: %{
        resource: Ash.Resource.t(),
        query: Ash.Query.t(),
        actor: term()
      }
    }
  | %{
      type: :flow_transaction,
      metadata: %{step_name: atom() | [term()], flow: module(), actor: term()}
    }
  | %{type: :custom, metadata: map()}
  | %{type: atom(), metadata: map()}

Link to this section Callbacks

add_aggregate( data_layer_query, t, t )

(optional)

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

add_aggregates( data_layer_query, list, t )

(optional)

@callback add_aggregates(
  data_layer_query(),
  [Ash.Query.Aggregate.t()],
  Ash.Resource.t()
) :: {:ok, data_layer_query()} | {:error, term()}

add_calculation( data_layer_query, t, expression, t )

(optional)

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

add_calculations( data_layer_query, list, t )

(optional)

@callback add_calculations(
  data_layer_query(),
  [{Ash.Query.Calculation.t(), expression :: any()}],
  Ash.Resource.t()
) :: {:ok, data_layer_query()} | {:error, term()}

bulk_create( t, t, options )

(optional)

@callback bulk_create(
  Ash.Resource.t(),
  Enumerable.t(Ash.Changeset.t()),
  options :: bulk_options()
) ::
  {:ok,
   Enumerable.t(:ok | {:ok, Ash.Resource.record()} | {:error, Ash.Error.t()})}
  | {:error, Ash.Error.t()}

can?(arg1, feature)

@callback can?(Ash.Resource.t() | Spark.Dsl.t(), feature()) :: boolean()

create(t, t)

(optional)

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

destroy(t, t)

(optional)

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

distinct(data_layer_query, list, resource)

(optional)

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

filter(data_layer_query, t, resource)

(optional)

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

functions(t)

(optional)

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

in_transaction?(t)

(optional)

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

limit( data_layer_query, limit, resource )

(optional)

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

lock(data_layer_query, lock_type, resource)

(optional)

@callback lock(data_layer_query(), lock_type(), resource :: Ash.Resource.t()) ::
  {:ok, data_layer_query()} | {:error, term()}

offset( data_layer_query, offset, resource )

(optional)

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

resource_to_query(t, t)

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

rollback(t, term)

(optional)

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

run_aggregate_query( data_layer_query, list, t )

(optional)

@callback 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)

@callback 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, t)

(optional)

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

run_query_with_lateral_join( data_layer_query, list, source_resource, list )

(optional)

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

select( data_layer_query, select, resource )

(optional)

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

set_context(t, data_layer_query, map)

(optional)

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

set_tenant(t, data_layer_query, term)

(optional)

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

sort(data_layer_query, t, resource)

(optional)

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

source(t)

(optional)

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

transaction( t, function, arg3, reason )

(optional)

@callback transaction(
  Ash.Resource.t(),
  (() -> term()),
  nil | pos_integer(),
  reason :: transaction_reason()
) :: {:ok, term()} | {:error, term()}

transform_query(t)

(optional)

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

update(t, t)

(optional)

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

upsert(t, t, list)

(optional)

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

Link to this section Functions

add_aggregates(query, aggregates, resource)

@spec add_aggregates(data_layer_query(), [Ash.Query.Aggregate.t()], Ash.Resource.t()) ::
  {:ok, data_layer_query()} | {:error, term()}

add_calculations(query, calculations, resource)

@spec add_calculations(
  data_layer_query(),
  [{Ash.Query.Calculation.t(), expression :: term()}],
  Ash.Resource.t()
) :: {:ok, data_layer_query()} | {:error, term()}

bulk_create(resource, changesets, options)

@spec bulk_create(
  Ash.Resource.t(),
  Enumerable.t(Ash.Changeset.t()),
  options :: bulk_options()
) :: :ok | {:ok, Enumerable.t(Ash.Resource.record())} | {:error, Ash.Error.t()}

can?(feature, resource)

@spec can?(feature(), Ash.Resource.t() | Spark.Dsl.t()) :: boolean()

create(resource, changeset)

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

data_layer(resource)

@spec data_layer(Ash.Resource.t() | Spark.Dsl.t()) :: t()

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

data_layer_can?(resource, feature)

@spec data_layer_can?(Ash.Resource.t() | Spark.Dsl.t(), feature()) :: boolean()

Whether or not the data layer supports a specific feature

data_layer_functions(resource)

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

Custom functions supported by the data layer of the resource

destroy(resource, changeset)

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

distinct(query, distinct, resource)

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

filter(query, filter, resource)

@spec 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)

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

lock(query, lock_type, resource)

@spec lock(
  data_layer_query(),
  lock_type :: lock_type() | nil,
  resource :: Ash.Resource.t()
) ::
  {:ok, data_layer_query()} | {:error, term()}

offset(query, offset, resource)

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

resource_to_query(resource, api)

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

rollback(resource, term)

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

Rolls back the current transaction

run_aggregate_query(query, aggregates, resource)

@spec 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)

@spec 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)

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

set_context(resource, query, map)

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

set_tenant(resource, query, term)

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

sort(query, sort, resource)

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

source(resource)

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

transaction(resource_or_resources, func, timeout \\ nil, reason \\ %{type: :custom, metadata: %{}})

@spec transaction(
  Ash.Resource.t() | [Ash.Resource.t()],
  (() -> term()),
  nil | pos_integer(),
  reason :: transaction_reason()
) :: term()

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

transform_query(query)

update(resource, changeset)

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

upsert(resource, changeset, keys)

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

Settings View Source Ash.DataLayer behaviour (ash v2.9.24)

Link to this section Summary

Types

Callbacks

Functions

Link to this section Types

bulk_options()

data_layer_query()

feature()

lateral_join_link()

lock_type()

t()

transaction_reason()

Link to this section Callbacks

add_aggregate( data_layer_query, t, t )

add_aggregates( data_layer_query, list, t )

add_calculation( data_layer_query, t, expression, t )

add_calculations( data_layer_query, list, t )

bulk_create( t, t, options )

can?(arg1, feature)

create(t, t)

destroy(t, t)

distinct(data_layer_query, list, resource)

filter(data_layer_query, t, resource)

functions(t)

in_transaction?(t)

limit( data_layer_query, limit, resource )

lock(data_layer_query, lock_type, resource)

offset( data_layer_query, offset, resource )

resource_to_query(t, t)

rollback(t, term)

run_aggregate_query( data_layer_query, list, t )

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

run_query(data_layer_query, t)

run_query_with_lateral_join( data_layer_query, list, source_resource, list )

select( data_layer_query, select, resource )

set_context(t, data_layer_query, map)

set_tenant(t, data_layer_query, term)

sort(data_layer_query, t, resource)

source(t)

transaction( t, function, arg3, reason )

transform_query(t)

update(t, t)

upsert(t, t, list)

Link to this section Functions

add_aggregates(query, aggregates, resource)

add_calculations(query, calculations, resource)

bulk_create(resource, changesets, options)

can?(feature, resource)

create(resource, changeset)

data_layer(resource)

data_layer_can?(resource, feature)

data_layer_functions(resource)

destroy(resource, changeset)

distinct(query, distinct, resource)

filter(query, filter, resource)

functions(resource)

in_transaction?(resource)

limit(query, limit, resource)

lock(query, lock_type, resource)

offset(query, offset, resource)

resource_to_query(resource, api)

rollback(resource, term)

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)

transaction(resource_or_resources, func, timeout \\ nil, reason \\ %{type: :custom, metadata: %{}})

transform_query(query)

update(resource, changeset)

upsert(resource, changeset, keys)

View Source Ash.DataLayer behaviour (ash v2.9.24)