View Source Ash (ash v2.17.0)

General purpose tools for working with Ash and Ash resources.

Summary

Functions

aggregate(arg1, arg2)

See Ash.Api.GlobalInterface.aggregate/2.

aggregate(arg1, arg2, arg3)

See Ash.Api.GlobalInterface.aggregate/3.

aggregate!(arg1, arg2)

See Ash.Api.GlobalInterface.aggregate!/2.

aggregate!(arg1, arg2, arg3)

See Ash.Api.GlobalInterface.aggregate!/3.

avg(arg1, arg2)

See Ash.Api.GlobalInterface.avg/2.

avg(arg1, arg2, arg3)

See Ash.Api.GlobalInterface.avg/3.

avg!(arg1, arg2)

See Ash.Api.GlobalInterface.avg!/2.

avg!(arg1, arg2, arg3)

See Ash.Api.GlobalInterface.avg!/3.

bulk_create(arg1, arg2, arg3)

See Ash.Api.GlobalInterface.bulk_create/3.

bulk_create(arg1, arg2, arg3, arg4)

See Ash.Api.GlobalInterface.bulk_create/4.

bulk_create!(arg1, arg2, arg3)

See Ash.Api.GlobalInterface.bulk_create!/3.

bulk_create!(arg1, arg2, arg3, arg4)

See Ash.Api.GlobalInterface.bulk_create!/4.

calculate(arg1, arg2)

See Ash.Api.GlobalInterface.calculate/2.

calculate(arg1, arg2, arg3)

See Ash.Api.GlobalInterface.calculate/3.

calculate!(arg1, arg2)

See Ash.Api.GlobalInterface.calculate!/2.

calculate!(arg1, arg2, arg3)

See Ash.Api.GlobalInterface.calculate!/3.

can(arg1, arg2)

See Ash.Api.GlobalInterface.can/2.

can(arg1, arg2, arg3)

See Ash.Api.GlobalInterface.can/3.

can?(arg1, arg2)

See Ash.Api.GlobalInterface.can?/2.

can?(arg1, arg2, arg3)

See Ash.Api.GlobalInterface.can?/3.

context_to_opts(map, add_to \\ [])

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

count(arg1)

See Ash.Api.GlobalInterface.count/1.

count(arg1, arg2)

See Ash.Api.GlobalInterface.count/2.

count!(arg1)

See Ash.Api.GlobalInterface.count!/1.

count!(arg1, arg2)

See Ash.Api.GlobalInterface.count!/2.

create(arg1)

See Ash.Api.GlobalInterface.create/1.

create(arg1, arg2)

See Ash.Api.GlobalInterface.create/2.

create!(arg1)

See Ash.Api.GlobalInterface.create!/1.

create!(arg1, arg2)

See Ash.Api.GlobalInterface.create!/2.

destroy(arg1)

See Ash.Api.GlobalInterface.destroy/1.

destroy(arg1, arg2)

See Ash.Api.GlobalInterface.destroy/2.

destroy!(arg1)

See Ash.Api.GlobalInterface.destroy!/1.

destroy!(arg1, arg2)

See Ash.Api.GlobalInterface.destroy!/2.

exists(arg1)

See Ash.Api.GlobalInterface.exists/1.

exists(arg1, arg2)

See Ash.Api.GlobalInterface.exists/2.

exists?(arg1)

See Ash.Api.GlobalInterface.exists?/1.

exists?(arg1, arg2)

See Ash.Api.GlobalInterface.exists?/2.

first(arg1, arg2)

See Ash.Api.GlobalInterface.first/2.

first(arg1, arg2, arg3)

See Ash.Api.GlobalInterface.first/3.

first!(arg1, arg2)

See Ash.Api.GlobalInterface.first!/2.

first!(arg1, arg2, arg3)

See Ash.Api.GlobalInterface.first!/3.

get(arg1, arg2)

See Ash.Api.GlobalInterface.get/2.

get(arg1, arg2, arg3)

See Ash.Api.GlobalInterface.get/3.

get!(arg1, arg2)

See Ash.Api.GlobalInterface.get!/2.

get!(arg1, arg2, arg3)

See Ash.Api.GlobalInterface.get!/3.

get_actor()

Gets the current actor from the process dictionary

get_authorize?()

Gets the current authorize? from the process dictionary

get_context()

Gets the current context from the process dictionary

get_context_for_transfer(opts \\ [])

Gets all of the ash context so it can be set into a new process.

get_tenant()

Gets the current tenant from the process dictionary

get_tracer()

Gets the current tracer

list(arg1, arg2)

See Ash.Api.GlobalInterface.list/2.

list(arg1, arg2, arg3)

See Ash.Api.GlobalInterface.list/3.

list!(arg1, arg2)

See Ash.Api.GlobalInterface.list!/2.

list!(arg1, arg2, arg3)

See Ash.Api.GlobalInterface.list!/3.

load(arg1, arg2)

See Ash.Api.GlobalInterface.load/2.

load(arg1, arg2, arg3)

See Ash.Api.GlobalInterface.load/3.

load!(arg1, arg2)

See Ash.Api.GlobalInterface.load!/2.

load!(arg1, arg2, arg3)

See Ash.Api.GlobalInterface.load!/3.

max(arg1, arg2)

See Ash.Api.GlobalInterface.max/2.

max(arg1, arg2, arg3)

See Ash.Api.GlobalInterface.max/3.

max!(arg1, arg2)

See Ash.Api.GlobalInterface.max!/2.

max!(arg1, arg2, arg3)

See Ash.Api.GlobalInterface.max!/3.

merge_context(map)

Deep merges context into the process dictionary that is used for all changesets and queries.

min(arg1, arg2)

See Ash.Api.GlobalInterface.min/2.

min(arg1, arg2, arg3)

See Ash.Api.GlobalInterface.min/3.

min!(arg1, arg2)

See Ash.Api.GlobalInterface.min!/2.

min!(arg1, arg2, arg3)

See Ash.Api.GlobalInterface.min!/3.

page(arg1, arg2)

See Ash.Api.GlobalInterface.page/2.

read(arg1)

See Ash.Api.GlobalInterface.read/1.

read(arg1, arg2)

See Ash.Api.GlobalInterface.read/2.

read!(arg1)

See Ash.Api.GlobalInterface.read!/1.

read!(arg1, arg2)

See Ash.Api.GlobalInterface.read!/2.

read_one(arg1)

See Ash.Api.GlobalInterface.read_one/1.

read_one(arg1, arg2)

See Ash.Api.GlobalInterface.read_one/2.

read_one!(arg1)

See Ash.Api.GlobalInterface.read_one!/1.

read_one!(arg1, arg2)

See Ash.Api.GlobalInterface.read_one!/2.

reload(arg1)

See Ash.Api.GlobalInterface.reload/1.

remove_tracer(module)

Removes a tracer from the process dictionary.

run_action(arg1)

See Ash.Api.GlobalInterface.run_action/1.

run_action(arg1, arg2)

See Ash.Api.GlobalInterface.run_action/2.

run_action!(arg1)

See Ash.Api.GlobalInterface.run_action!/1.

run_action!(arg1, arg2)

See Ash.Api.GlobalInterface.run_action!/2.

set_actor(map)

Sets actor into the process dictionary that is used for all changesets and queries.

set_authorize?(map)

Sets authorize? into the process dictionary that is used for all changesets and queries.

set_context(map)

Sets context into the process dictionary that is used for all changesets and queries.

set_tenant(tenant)

Sets tenant into the process dictionary that is used for all changesets and queries.

set_tracer(module)

Sets the tracer into the process dictionary that will be used to trace requests

stream!(arg1)

See Ash.Api.GlobalInterface.stream!/1.

stream!(arg1, arg2)

See Ash.Api.GlobalInterface.stream!/2.

sum(arg1, arg2)

See Ash.Api.GlobalInterface.sum/2.

sum(arg1, arg2, arg3)

See Ash.Api.GlobalInterface.sum/3.

sum!(arg1, arg2)

See Ash.Api.GlobalInterface.sum!/2.

sum!(arg1, arg2, arg3)

See Ash.Api.GlobalInterface.sum!/3.

transfer_context(map, opts \\ [])
update(arg1)

See Ash.Api.GlobalInterface.update/1.

update(arg1, arg2)

See Ash.Api.GlobalInterface.update/2.

update!(arg1)

See Ash.Api.GlobalInterface.update!/1.

update!(arg1, arg2)

See Ash.Api.GlobalInterface.update!/2.

update_context(fun)

Updates the context into the process dictionary that is used for all changesets and queries.

Functions

Link to this function

aggregate(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.aggregate/2.

Link to this function

aggregate(arg1, arg2, arg3)

View Source

See Ash.Api.GlobalInterface.aggregate/3.

Link to this function

aggregate!(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.aggregate!/2.

Link to this function

aggregate!(arg1, arg2, arg3)

View Source

See Ash.Api.GlobalInterface.aggregate!/3.

Link to this function

avg(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.avg/2.

Link to this function

avg(arg1, arg2, arg3)

View Source

See Ash.Api.GlobalInterface.avg/3.

Link to this function

avg!(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.avg!/2.

Link to this function

avg!(arg1, arg2, arg3)

View Source

See Ash.Api.GlobalInterface.avg!/3.

Link to this function

bulk_create(arg1, arg2, arg3)

View Source

See Ash.Api.GlobalInterface.bulk_create/3.

Link to this function

bulk_create(arg1, arg2, arg3, arg4)

View Source

See Ash.Api.GlobalInterface.bulk_create/4.

Link to this function

bulk_create!(arg1, arg2, arg3)

View Source

See Ash.Api.GlobalInterface.bulk_create!/3.

Link to this function

bulk_create!(arg1, arg2, arg3, arg4)

View Source

See Ash.Api.GlobalInterface.bulk_create!/4.

Link to this function

calculate(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.calculate/2.

Link to this function

calculate(arg1, arg2, arg3)

View Source

See Ash.Api.GlobalInterface.calculate/3.

Link to this function

calculate!(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.calculate!/2.

Link to this function

calculate!(arg1, arg2, arg3)

View Source

See Ash.Api.GlobalInterface.calculate!/3.

Link to this function

can(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.can/2.

Link to this function

can(arg1, arg2, arg3)

View Source

See Ash.Api.GlobalInterface.can/3.

Link to this function

can?(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.can?/2.

Link to this function

can?(arg1, arg2, arg3)

View Source

See Ash.Api.GlobalInterface.can?/3.

Link to this function

context_to_opts(map, add_to \\ [])

View Source

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

Link to this function

count(arg1)

View Source

See Ash.Api.GlobalInterface.count/1.

Link to this function

count(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.count/2.

Link to this function

count!(arg1)

View Source

See Ash.Api.GlobalInterface.count!/1.

Link to this function

count!(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.count!/2.

Link to this function

create(arg1)

View Source

See Ash.Api.GlobalInterface.create/1.

Link to this function

create(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.create/2.

Link to this function

create!(arg1)

View Source

See Ash.Api.GlobalInterface.create!/1.

Link to this function

create!(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.create!/2.

Link to this function

destroy(arg1)

View Source

See Ash.Api.GlobalInterface.destroy/1.

Link to this function

destroy(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.destroy/2.

Link to this function

destroy!(arg1)

View Source

See Ash.Api.GlobalInterface.destroy!/1.

Link to this function

destroy!(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.destroy!/2.

Link to this function

exists(arg1)

View Source

See Ash.Api.GlobalInterface.exists/1.

Link to this function

exists(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.exists/2.

Link to this function

exists?(arg1)

View Source

See Ash.Api.GlobalInterface.exists?/1.

Link to this function

exists?(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.exists?/2.

Link to this function

first(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.first/2.

Link to this function

first(arg1, arg2, arg3)

View Source

See Ash.Api.GlobalInterface.first/3.

Link to this function

first!(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.first!/2.

Link to this function

first!(arg1, arg2, arg3)

View Source

See Ash.Api.GlobalInterface.first!/3.

Link to this function

get(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.get/2.

Link to this function

get(arg1, arg2, arg3)

View Source

See Ash.Api.GlobalInterface.get/3.

Link to this function

get!(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.get!/2.

Link to this function

get!(arg1, arg2, arg3)

View Source

See Ash.Api.GlobalInterface.get!/3.

Link to this function

get_actor()

View Source 
@spec get_actor() :: term()

Gets the current actor from the process dictionary

Link to this function

get_authorize?()

View Source 
@spec get_authorize?() :: term()

Gets the current authorize? from the process dictionary

Link to this function

get_context()

View Source 
@spec get_context() :: term()

Gets the current context from the process dictionary

Link to this function

get_context_for_transfer(opts \\ [])

View Source 
@spec get_context_for_transfer(opts :: Keyword.t()) :: term()

Gets all of the ash context so it can be set into a new process.

Use transfer_context/1 in the new process to set the context.

Link to this function

get_tenant()

View Source 
@spec get_tenant() :: term()

Gets the current tenant from the process dictionary

Link to this function

get_tracer()

View Source 
@spec get_tracer() :: term()

Gets the current tracer

Link to this function

list(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.list/2.

Link to this function

list(arg1, arg2, arg3)

View Source

See Ash.Api.GlobalInterface.list/3.

Link to this function

list!(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.list!/2.

Link to this function

list!(arg1, arg2, arg3)

View Source

See Ash.Api.GlobalInterface.list!/3.

Link to this function

load(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.load/2.

Link to this function

load(arg1, arg2, arg3)

View Source

See Ash.Api.GlobalInterface.load/3.

Link to this function

load!(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.load!/2.

Link to this function

load!(arg1, arg2, arg3)

View Source

See Ash.Api.GlobalInterface.load!/3.

Link to this function

max(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.max/2.

Link to this function

max(arg1, arg2, arg3)

View Source

See Ash.Api.GlobalInterface.max/3.

Link to this function

max!(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.max!/2.

Link to this function

max!(arg1, arg2, arg3)

View Source

See Ash.Api.GlobalInterface.max!/3.

Link to this function

merge_context(map)

View Source 
@spec merge_context(map()) :: :ok

Deep merges context into the process dictionary that is used for all changesets and queries.

Link to this function

min(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.min/2.

Link to this function

min(arg1, arg2, arg3)

View Source

See Ash.Api.GlobalInterface.min/3.

Link to this function

min!(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.min!/2.

Link to this function

min!(arg1, arg2, arg3)

View Source

See Ash.Api.GlobalInterface.min!/3.

Link to this function

page(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.page/2.

Link to this function

read(arg1)

View Source

See Ash.Api.GlobalInterface.read/1.

Link to this function

read(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.read/2.

Link to this function

read!(arg1)

View Source

See Ash.Api.GlobalInterface.read!/1.

Link to this function

read!(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.read!/2.

Link to this function

read_one(arg1)

View Source

See Ash.Api.GlobalInterface.read_one/1.

Link to this function

read_one(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.read_one/2.

Link to this function

read_one!(arg1)

View Source

See Ash.Api.GlobalInterface.read_one!/1.

Link to this function

read_one!(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.read_one!/2.

Link to this function

reload(arg1)

View Source

See Ash.Api.GlobalInterface.reload/1.

Link to this function

remove_tracer(module)

View Source 
@spec remove_tracer(module() | [module()]) :: :ok

Removes a tracer from the process dictionary.

Link to this function

run_action(arg1)

View Source

See Ash.Api.GlobalInterface.run_action/1.

Link to this function

run_action(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.run_action/2.

Link to this function

run_action!(arg1)

View Source

See Ash.Api.GlobalInterface.run_action!/1.

Link to this function

run_action!(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.run_action!/2.

Link to this function

set_actor(map)

View Source 
@spec set_actor(map()) :: :ok

Sets actor into the process dictionary that is used for all changesets and queries.

Link to this function

set_authorize?(map)

View Source 
@spec set_authorize?(map()) :: :ok

Sets authorize? into the process dictionary that is used for all changesets and queries.

Link to this function

set_context(map)

View Source 
@spec set_context(map()) :: :ok

Sets context into the process dictionary that is used for all changesets and queries.

In Ash 3.0, this will be updated to deep merge

Link to this function

set_tenant(tenant)

View Source 
@spec set_tenant(String.t()) :: :ok

Sets tenant into the process dictionary that is used for all changesets and queries.

Link to this function

set_tracer(module)

View Source 
@spec set_tracer(module() | [module()]) :: :ok

Sets the tracer into the process dictionary that will be used to trace requests

Link to this function

stream!(arg1)

View Source

See Ash.Api.GlobalInterface.stream!/1.

Link to this function

stream!(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.stream!/2.

Link to this function

sum(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.sum/2.

Link to this function

sum(arg1, arg2, arg3)

View Source

See Ash.Api.GlobalInterface.sum/3.

Link to this function

sum!(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.sum!/2.

Link to this function

sum!(arg1, arg2, arg3)

View Source

See Ash.Api.GlobalInterface.sum!/3.

Link to this function

transfer_context(map, opts \\ [])

View Source 
@spec transfer_context(term(), opts :: Keyword.t()) :: :ok
Link to this function

update(arg1)

View Source

See Ash.Api.GlobalInterface.update/1.

Link to this function

update(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.update/2.

Link to this function

update!(arg1)

View Source

See Ash.Api.GlobalInterface.update!/1.

Link to this function

update!(arg1, arg2)

View Source

See Ash.Api.GlobalInterface.update!/2.

Link to this function

update_context(fun)

View Source 
@spec update_context((map() -> map())) :: :ok

Updates the context into the process dictionary that is used for all changesets and queries.