View Source Ash (ash v2.19.3)

General purpose tools for working with Ash and Ash resources.

Summary

Functions

Calls Ash.Api.aggregate/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.aggregate/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.aggregate!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.aggregate!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.avg/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.avg/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.avg!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.avg!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.bulk_create/4 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.bulk_create/4 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.bulk_create!/4 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.bulk_create!/4 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.bulk_destroy/4 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.bulk_destroy/4 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.bulk_destroy!/4 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.bulk_destroy!/4 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.bulk_update/4 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.bulk_update/4 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.bulk_update!/4 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.bulk_update!/4 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.calculate/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.calculate/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.calculate!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.calculate!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.can/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.can/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.can?/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.can?/3 on the resource's configured api. See those callback docs for more.

Converts a context map to opts to be passed into an action.

Calls Ash.Api.count/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.count/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.count!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.count!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.create/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.create/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.create!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.create!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.destroy/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.destroy/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.destroy!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.destroy!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.exists/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.exists/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.exists?/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.exists?/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.first/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.first/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.first!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.first!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.get/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.get/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.get!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.get!/3 on the resource's configured api. See those callback docs for more.

get_actor() deprecated
get_authorize?() deprecated
get_context() deprecated
get_tenant() deprecated
get_tracer() deprecated

Calls Ash.Api.list/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.list/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.list!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.list!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.load/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.load/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.load!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.load!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.max/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.max/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.max!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.max!/3 on the resource's configured api. See those callback docs for more.

merge_context(map) deprecated

Calls Ash.Api.min/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.min/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.min!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.min!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.page/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.read/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.read/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.read!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.read!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.read_one/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.read_one/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.read_one!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.read_one!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.reload/1 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.run_action/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.run_action/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.run_action!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.run_action!/2 on the resource's configured api. See those callback docs for more.

set_actor(map) deprecated
set_authorize?(map) deprecated
set_context(map) deprecated
set_tenant(tenant) deprecated
set_tracer(module) deprecated

Calls Ash.Api.stream!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.stream!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.sum/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.sum/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.sum!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.sum!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.update/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.update/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.update!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.update!/2 on the resource's configured api. See those callback docs for more.

update_context(fun) deprecated

Functions

Calls Ash.Api.aggregate/3 on the resource's configured api. See those callback docs for more.

Link to this function

aggregate(arg1, arg2, arg3)

View Source

Calls Ash.Api.aggregate/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.aggregate!/3 on the resource's configured api. See those callback docs for more.

Link to this function

aggregate!(arg1, arg2, arg3)

View Source

Calls Ash.Api.aggregate!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.avg/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.avg/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.avg!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.avg!/3 on the resource's configured api. See those callback docs for more.

Link to this function

bulk_create(arg1, arg2, arg3)

View Source

Calls Ash.Api.bulk_create/4 on the resource's configured api. See those callback docs for more.

Link to this function

bulk_create(arg1, arg2, arg3, arg4)

View Source

Calls Ash.Api.bulk_create/4 on the resource's configured api. See those callback docs for more.

Link to this function

bulk_create!(arg1, arg2, arg3)

View Source

Calls Ash.Api.bulk_create!/4 on the resource's configured api. See those callback docs for more.

Link to this function

bulk_create!(arg1, arg2, arg3, arg4)

View Source

Calls Ash.Api.bulk_create!/4 on the resource's configured api. See those callback docs for more.

Link to this function

bulk_destroy(arg1, arg2, arg3)

View Source

Calls Ash.Api.bulk_destroy/4 on the resource's configured api. See those callback docs for more.

Link to this function

bulk_destroy(arg1, arg2, arg3, arg4)

View Source

Calls Ash.Api.bulk_destroy/4 on the resource's configured api. See those callback docs for more.

Link to this function

bulk_destroy!(arg1, arg2, arg3)

View Source

Calls Ash.Api.bulk_destroy!/4 on the resource's configured api. See those callback docs for more.

Link to this function

bulk_destroy!(arg1, arg2, arg3, arg4)

View Source

Calls Ash.Api.bulk_destroy!/4 on the resource's configured api. See those callback docs for more.

Link to this function

bulk_update(arg1, arg2, arg3)

View Source

Calls Ash.Api.bulk_update/4 on the resource's configured api. See those callback docs for more.

Link to this function

bulk_update(arg1, arg2, arg3, arg4)

View Source

Calls Ash.Api.bulk_update/4 on the resource's configured api. See those callback docs for more.

Link to this function

bulk_update!(arg1, arg2, arg3)

View Source

Calls Ash.Api.bulk_update!/4 on the resource's configured api. See those callback docs for more.

Link to this function

bulk_update!(arg1, arg2, arg3, arg4)

View Source

Calls Ash.Api.bulk_update!/4 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.calculate/3 on the resource's configured api. See those callback docs for more.

Link to this function

calculate(arg1, arg2, arg3)

View Source

Calls Ash.Api.calculate/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.calculate!/3 on the resource's configured api. See those callback docs for more.

Link to this function

calculate!(arg1, arg2, arg3)

View Source

Calls Ash.Api.calculate!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.can/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.can/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.can?/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.can?/3 on the resource's configured api. See those callback docs for more.

Link to this function

context_to_opts(map, add_to \\ [])

View Source

Converts a context map to opts to be passed into an action.

Calls Ash.Api.count/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.count/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.count!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.count!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.create/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.create/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.create!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.create!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.destroy/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.destroy/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.destroy!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.destroy!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.exists/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.exists/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.exists?/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.exists?/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.first/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.first/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.first!/3 on the resource's configured api. See those callback docs for more.

Link to this function

first!(arg1, arg2, arg3)

View Source

Calls Ash.Api.first!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.get/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.get/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.get!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.get!/3 on the resource's configured api. See those callback docs for more.

This function is deprecated. Gets the current actor from the process dictionary .
@spec get_actor() :: term()
This function is deprecated. Gets the current authorize? from the process dictionary .
@spec get_authorize?() :: term()
This function is deprecated. Gets the current context from the process dictionary .
@spec get_context() :: term()
Link to this function

get_context_for_transfer(opts \\ [])

View Source
This function is deprecated. See `Ash.ProcessHelpers`. This alias will be removed in 3.0.

See Ash.ProcessHelpers.get_context_for_transfer/1.

This function is deprecated. Gets the current tenant from the process dictionary .
@spec get_tenant() :: term()
This function is deprecated. Gets the current tracer .
@spec get_tracer() :: term()

Calls Ash.Api.list/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.list/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.list!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.list!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.load/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.load/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.load!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.load!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.max/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.max/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.max!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.max!/3 on the resource's configured api. See those callback docs for more.

This function is deprecated. Deep merges context into the process dictionary that is used for all changesets and queries. .
@spec merge_context(map()) :: :ok

Calls Ash.Api.min/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.min/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.min!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.min!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.page/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.read/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.read/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.read!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.read!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.read_one/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.read_one/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.read_one!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.read_one!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.reload/1 on the resource's configured api. See those callback docs for more.

This function is deprecated. Removes a tracer from the process dictionary. .
@spec remove_tracer(module() | [module()]) :: :ok

Calls Ash.Api.run_action/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.run_action/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.run_action!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.run_action!/2 on the resource's configured api. See those callback docs for more.

This function is deprecated. Sets actor into the process dictionary that is used for all changesets and queries. .
@spec set_actor(map()) :: :ok
This function is deprecated. Sets authorize? into the process dictionary that is used for all changesets and queries. .
@spec set_authorize?(map()) :: :ok
This function is deprecated. Sets context into the process dictionary that is used for all changesets and queries. .
@spec set_context(map()) :: :ok
This function is deprecated. Sets tenant into the process dictionary that is used for all changesets and queries. .
@spec set_tenant(term()) :: :ok
This function is deprecated. Sets the tracer into the process dictionary that will be used to trace requests .
@spec set_tracer(module() | [module()]) :: :ok

Calls Ash.Api.stream!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.stream!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.sum/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.sum/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.sum!/3 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.sum!/3 on the resource's configured api. See those callback docs for more.

Link to this function

transfer_context(term, opts \\ [])

View Source
This function is deprecated. See `Ash.ProcessHelpers`. This alias will be removed in 3.0.

See Ash.ProcessHelpers.transfer_context/2.

Calls Ash.Api.update/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.update/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.update!/2 on the resource's configured api. See those callback docs for more.

Calls Ash.Api.update!/2 on the resource's configured api. See those callback docs for more.

This function is deprecated. Updates the context into the process dictionary that is used for all changesets and queries. .
@spec update_context((map() -> map())) :: :ok