ash
v3.4.68
GUIDES
Modules
Mix
Tasks
API Reference
Modules
Mix Tasks
Home
Dive In
About the Documentation
Tutorials
Topics
How-to
Reference
Packages
Start Here
Get Started
Goals
Requirements
Steps
Working with relationships
About Ash
What is Ash?
Why should I use it?
Watch the ElixirConf 2023 Talk
Design Principles
Anything, not Everything
Declarative, Introspectable, Derivable
Configuration over Convention
Pragmatism First
Community
Contributing to Ash
Welcome!
Rules
Alternatives
Application Frameworks
Application Design
Building APIs
Working with Data
Authentication
Authorization
Validation
Changelog
v3.4.68 (2025-03-11)
v3.4.67 (2025-03-04)
v3.4.66 (2025-03-03)
v3.4.65 (2025-02-25)
v3.4.64 (2025-02-17)
v3.4.63 (2025-02-11)
v3.4.62 (2025-01-31)
v3.4.61 (2025-01-31)
v3.4.60 (2025-01-27)
v3.4.59 (2025-01-27)
v3.4.58 (2025-01-26)
v3.4.57 (2025-01-23)
3.4.56 (2025-01-21)
v3.4.55 (2025-01-13)
v3.4.54 (2025-01-09)
v3.4.53 (2025-01-08)
v3.4.52 (2025-01-06)
v3.4.51 (2025-01-03)
v3.4.50 (2025-01-01)
v3.4.49 (2024-12-22)
v3.4.48 (2024-12-20)
v3.4.47 (2024-12-17)
v3.4.46 (2024-12-12)
v3.4.45 (2024-12-10)
v3.4.44 (2024-12-06)
v3.4.43 (2024-11-20)
v3.4.42 (2024-11-07)
v3.4.41 (2024-11-05)
v3.4.40 (2024-11-04)
v3.4.39 (2024-11-01)
v3.4.38 (2024-10-31)
v3.4.37 (2024-10-30)
v3.4.36 (2024-10-24)
v3.4.35 (2024-10-22)
v3.4.34 (2024-10-21)
v3.4.33 (2024-10-18)
v3.4.32 (2024-10-14)
v3.4.31 (2024-10-14)
v3.4.30 (2024-10-14)
v3.4.29 (2024-10-13)
v3.4.28 (2024-10-10)
v3.4.27 (2024-10-10)
v3.4.26 (2024-10-08)
v3.4.25 (2024-10-07)
v3.4.24 (2024-10-07)
v3.4.23 (2024-10-03)
v03.4.22 (2024-10-01)
v3.4.21 (2024-09-24)
v3.4.20 (2024-09-23)
v3.4.19 (2024-09-21)
v3.4.18 (2024-09-20)
v3.4.17 (2024-09-19)
v3.4.16 (2024-09-18)
v3.4.15 (2024-09-17)
v3.4.14 (2024-09-17)
v3.4.13 (2024-09-17)
v3.4.12 (2024-09-16)
v3.4.11 (2024-09-13)
v3.4.10 (2024-09-13)
v3.4.9 (2024-09-13)
v3.4.8 (2024-09-09)
v3.4.7 (2024-09-06)
v3.4.6 (2024-09-06)
v3.4.5 (2024-09-05)
v3.4.4 (2024-09-05)
v3.4.3 (2024-09-04)
v3.4.2 (2024-09-04)
v3.4.1 (2024-08-13)
v3.4.0 (2024-08-12)
v3.3.3 (2024-08-01)
v3.3.2 (2024-08-01)
v3.3.1 (2024-07-30)
v3.3.0 (2024-07-27)
v3.2.6 (2024-07-22)
v3.2.5 (2024-07-22)
v3.2.4 (2024-07-18)
v3.2.3 (2024-07-18)
v3.2.2 (2024-07-17)
v3.2.1 (2024-07-17)
v3.2.0 (2024-07-15)
v3.1.8 (2024-07-14)
v3.1.7 (2024-07-14)
v3.1.6 (2024-07-14)
v3.1.5 (2024-07-14)
v3.1.4 (2024-07-13)
v3.1.3 (2024-07-11)
v3.1.2 (2024-07-10)
v3.1.1 (2024-07-10)
v3.1.0 (2024-07-09)
v3.0.16 (2024-06-21)
v3.0.15 (2024-06-18)
v3.0.14 (2024-06-18)
v3.0.13 (2024-06-17)
v3.0.12 (2024-06-14)
v3.0.11 (2024-06-11)
v3.0.10 (2024-06-06)
v3.0.9 (2024-05-31)
v3.0.8 (2024-05-28)
v3.0.7 (2024-05-24)
v3.0.6 (2024-05-23)
v3.0.5 (2024-05-23)
v3.0.4 (2024-05-22)
3.0.3 (2024-05-22)
v3.0.2 (2024-05-15)
v3.0.1 (2024-05-14)
v3.0.0
3.0
Reference
Ash.Resource
attributes
relationships
actions
code_interface
resource
identities
changes
preparations
validations
aggregates
calculations
multitenancy
Ash.Domain
domain
resources
execution
authorization
Ash.Notifier.PubSub
Example
Debugging PubSub
Topic Templates
Important
Template parts
Custom Delimiters
Named Pubsub modules
Broadcast Types
pub_sub
Ash.Policy.Authorizer
policies
field_policies
Ash.DataLayer.Ets
ets
Ash.DataLayer.Mnesia
mnesia
Ash.Reactor
ash
Glossary
Action
Actor
Aggregate
Attribute
Authorizer
Calculation
Changeset
Domain
Extension
Filter
Identity
Notifier
Policy
Query
Record
Relationship
Resource
Tenant
Expressions
Operators
Functions
Fragments
String Fragments
Function Fragments
Sub-expressions
DateTime Functions
Primitives
Escape Hatches
Inline Aggregates
Templates
Custom Expressions
Filter semantics & joins
Portability
Parent
Resources
Domains
Grouping Resources
Centralized Code Interface
Configuring Cross-cutting Concerns
Attributes
Special attributes
Relationships
Relationships Basics
Managing related data
Kinds of relationships
Loading related data
no_attributes? true
Manual Relationships
Managing Relationships
Calculations
Primer
Declaring calculations on a resource
Custom calculations in the query
Arguments in calculations
Aggregates
Declaring aggregates on a resource
Using an aggregate
Aggregate types
Custom aggregates in the query
Join Filters
Inline Aggregates
Validations
Builtin Validations
Custom Validations
Anonymous Function Validations
Where
Action vs Global Validations
Atomic Validations
Changes
Builtin Changes
Custom Changes
Anonymous Function Changes
Where
Action vs Global Changes
Atomic Changes
Batches
Preparations
Builtin Preparations
Custom Preparations
Anonymous Function Queries
Action vs Global Preparations
Code Interface
Code interfaces on the resource
Using the code interface
Calculations
Bulk & atomic actions
Embedded Resources
Adding embedded resource attributes
Handling nil values
Editing embedded attributes
Calculations
Determining what action(s) will be called:
Adding a primary key
Identities
Usage in Extensions
Accessing the source changeset
Identities
Defining an identity
Using Ash.get
Using upserts
Creating unique constraints
Eager Checking
Pre Checking
Notifiers
What are notifiers for?
Built-in Notifiers
Creating your own notifier
Transactions
Actions
Actions
Primary Actions
Accepting Inputs
Idiomatic Actions
Private Inputs
Read Actions
Calling Read Actions
Ash.get!
Ash.read_one!
Pagination
What happens when you call Ash.Query.for_read/4
What happens when you run the action
Create Actions
Bulk creates
Performance
Returning a Stream
Upserts
What happens when you run a create Action
Update Actions
Atomics
Fully Atomic updates
What makes an action not atomic?
Bulk updates
Atomic
Atomic Batches
Stream
Running a standard update action
Atomic Upgrade
Destroy Actions
Soft Destroy
Calling Destroy Actions
Returning the destroyed record
Bulk Destroys
Atomic
Atomic Batches
Stream
Running the Destroy Action
Generic Actions
Calling Generic Actions
Why use generic actions?
Return types and constraints
Calling Generic Actions
Manual Actions
Manual Creates/Updates/Destroy
Manual Read Actions
Security
Actors & Authorization
Setting actor and authorize?
Default value of authorize?
Authorizers
Domain Authorization Configuration
Sensitive Data
Public & Private Attributes
Public & Private Arguments
Sensitive Attributes
Field Policies
Policies
Setup
Policies
Policy Groups
Checks
Field Policies
Debugging and Logging
Development
Project Structure
Example 1: Reads & Calculations
Example 2: Using external data in create actions
Generators
Installer
Generators
Patchers
Error Handling
Error Classes
Generating Errors
Examples of using non standard errors
Using an exception module
Showing errors over APIs
Testing
Async tests
Missed notifications
Development Utilities
Formatting DSLs
ElixirSense Plugin
Formatter plugin
Upgrade
Other Packages
Upgrading to 3.0
Significant Changes
Advanced
Reactor
Usage
Example
Actions
Handling failure.
Notifications
Running Reactors as an action
Monitoring
Packages
Telemetry
Tracing
After/Before Action Hooks
Pagination
Pagination in Ash
Offset Pagination
Keyset Pagination
Counting records
Relationship pagination
Pagination example
Offset pagination
Timeouts
Ways to Specify Timeouts
How are timeouts handled?
Multitenancy
Attribute Multitenancy
Tenant-Aware Identities
Context Multitenancy
Possible Values for tenant
Writing Extensions
Creating an extension
Using your extension
Base Resources
How To
Write Queries
Introduction
Setup
Read everything
Count all comments
Filtering
Sorting
Distinct
Load calculations/aggregates
Load relationships
Limit & Offset
Pagination
Define Polymorphic Relationships
Introduction
Defining our Resources
Defining our union type
Defining the calculation
Adding the calculation to our resource
Taking it further
Test Resources
Introduction
Testing Resources
Examples
Create a generator
Write some tests
Authorize Access to Resources
Introduction
Writing Policies
Example
Interacting with resources that have policies
Encrypt Attributes
Introduction
Encrypting attributes
Examples
Data is encrypted when modified and is not displayed when inspecting.
Prevent concurrent writes
Introduction
Add Optimistic Locking
Examples
Triggering a StaleRecord error
Refetching a record to get the latest version
Wrap External APIs
Introduction
Wrapping External APIs
Example
Now we can use this like any other Ash resource
Moved
Upgrade
Resources
Ash.CodeInterface
Summary
Functions
define_interface/3
params_and_opts/3
Ash.DataLayer
Summary
Types
bulk_create_options/0
bulk_update_options/0
data_layer_query/0
feature/0
lateral_join_link/0
lock_type/0
t/0
transaction_reason/0
Callbacks
add_aggregate/3
add_aggregates/3
add_calculation/4
add_calculations/3
bulk_create/3
calculate/3
can?/2
create/2
destroy/2
destroy_query/4
distinct/3
distinct_sort/3
filter/3
functions/1
in_transaction?/1
limit/3
lock/3
offset/3
prefer_lateral_join_for_many_to_many?/0
prefer_transaction?/1
prefer_transaction_for_atomic_updates?/1
resource_to_query/2
return_query/2
rollback/2
run_aggregate_query/3
run_aggregate_query_with_lateral_join/5
run_query/2
run_query_with_lateral_join/4
select/3
set_context/3
set_tenant/3
sort/3
source/1
transaction/4
transform_query/1
update/2
update_query/4
upsert/3
upsert/4
Functions
add_aggregates/3
add_calculations/3
bulk_create/3
calculate/3
can?/2
create/2
data_layer/1
data_layer_can?/2
data_layer_functions/1
destroy/2
destroy_query/3
distinct/3
distinct_sort/3
filter/3
functions/1
in_transaction?/1
limit/3
lock/3
offset/3
prefer_lateral_join_for_many_to_many?/1
prefer_transaction?/1
prefer_transaction_for_atomic_updates?/1
resource_to_query/2
return_query/2
rollback/2
run_aggregate_query/3
run_aggregate_query_with_lateral_join/5
run_query/2
run_query_with_lateral_join/4
select/3
set_context/3
set_tenant/3
sort/3
source/1
transaction/4
transform_query/1
update/2
update_query/3
upsert/4
Ash.Notifier
Summary
Callbacks
notify/1
requires_original_data?/2
Functions
notify/1
Ash.Notifier.Notification
Summary
Types
t/0
Functions
new/2
Ash.Resource.Attribute.Helpers
Summary
Functions
timestamps/1
Ash.Resource.Calculation
Summary
Types
opts/0
ref/0
t/0
Callbacks
calculate/3
describe/1
expression/2
has_expression?/0
init/1
load/3
strict_loads?/0
Functions
expr_calc/1
schema/0
Ash.Resource.Calculation.Builtins
Summary
Functions
concat/2
Ash.Resource.ManualCreate
Summary
Callbacks
bulk_create/3
create/3
Ash.Resource.ManualDestroy
Summary
Callbacks
bulk_destroy/3
destroy/3
Ash.Resource.ManualRead
Summary
Types
context/0
extra_info/0
Callbacks
load_relationships/5
read/4
Ash.Resource.ManualRelationship
Summary
Callbacks
load/3
select/1
Ash.Resource.ManualUpdate
Summary
Callbacks
bulk_update/3
update/3
Action Input & Interface
Ash
Summary
Types
actor/0
aggregate/0
load_statement/0
page_request/0
record_or_records/0
record_with_args/0
resource_with_args/0
Functions
aggregate/3
aggregate!/3
avg/3
avg!/3
bulk_create/4
bulk_create!/4
bulk_destroy/4
bulk_destroy!/4
bulk_update/4
bulk_update!/4
calculate/3
calculate!/3
calculate_opts/0
can/3
can?/3
context_to_opts/2
count/2
count!/2
create/3
create!/3
destroy/2
destroy!/2
exists/2
exists?/2
first/3
first!/3
get/3
get!/3
list/3
list!/3
load/3
load!/3
max/3
max!/3
min/3
min!/3
page/2
page!/2
read/2
read!/2
read_first/2
read_first!/2
read_one/2
read_one!/2
reload/2
reload!/2
run_action/2
run_action!/2
stream!/2
sum/3
sum!/3
update/3
update!/3
Ash.ActionInput
Summary
Types
t/0
Functions
add_error/3
fetch_argument/2
for_action/4
get_argument/2
new/2
set_argument/3
set_context/2
set_private_argument/3
set_tenant/2
Ash.BulkResult
Summary
Types
t/0
Ash.Changeset
Sections
Action Lifecycle
Summary
Types
after_action_fun/0
after_transaction_fun/0
around_action_callback/0
around_action_fun/0
around_action_result/0
around_transaction_callback/0
around_transaction_fun/0
around_transaction_result/0
before_action_fun/0
before_transaction_fun/0
error_info/0
manage_relationship_type/0
phase/0
t/0
Functions
accessing/3
add_error/3
after_action/3
after_transaction/3
apply_attributes/2
around_action/2
around_transaction/2
atomic_defaults/1
atomic_ref/2
atomic_update/2
atomic_update/3
attribute_present?/2
before_action/3
before_transaction/3
change_attribute/3
change_attributes/2
change_default_attribute/3
change_new_attribute/3
change_new_attribute_lazy/3
changing_attribute?/2
changing_attributes?/1
changing_relationship?/2
clear_change/2
delete_argument/2
deselect/2
ensure_selected/2
expand_upsert_fields/2
fetch_argument/2
fetch_argument_or_change/2
fetch_change/2
filter/2
for_action/4
for_create/4
for_destroy/4
for_update/4
force_change_attribute/3
force_change_attributes/2
force_change_new_attribute/3
force_change_new_attribute_lazy/3
force_delete_argument/2
force_set_argument/3
force_set_arguments/2
fully_atomic_changeset/4
get_argument/2
get_argument_or_attribute/2
get_attribute/2
get_data/2
handle_errors/2
handle_params/4
is_valid/1
load/2
loading?/2
manage_relationship/4
manage_relationship_opts/1
new/1
prepare_changeset_for_action/3
present?/2
put_context/3
run_atomic_change/3
run_before_transaction_hooks/1
select/3
selecting?/2
set_argument/3
set_arguments/2
set_context/2
set_on_upsert/2
set_private_argument/3
set_result/2
set_tenant/2
timeout/3
update_change/3
with_hooks/3
Ash.Domain
Summary
Types
t/0
Ash.Query
Sections
Capabilities & Limitations
Escape Hatches
Summary
Types
around_action_fun/0
around_callback/0
around_result/0
around_transaction_fun/0
t/0
Functions
accessing/3
add_error/3
after_action/2
aggregate/4
aggregate/5
apply_to/3
around_transaction/2
authorize_results/2
before_action/3
build/3
calculate/8
clear_result/1
data_layer_query/2
delete_argument/2
deselect/2
distinct/2
distinct_sort/3
ensure_selected/2
equivalent_to/2
equivalent_to?/2
fetch_argument/2
filter/2
filter_input/2
for_read/4
get_argument/2
limit/2
load/3
load_calculation_as/5
load_through/4
loading?/2
lock/2
merge_query_load/3
new/2
offset/2
page/2
put_context/3
select/3
selecting?/2
set_argument/3
set_arguments/2
set_context/2
set_domain/2
set_result/2
set_tenant/2
sort/3
sort_input/3
struct?/1
subset_of/2
subset_of?/2
superset_of/2
superset_of?/2
timeout/2
unload/2
unset/2
Queries
Ash.Query.Aggregate
Summary
Types
kind/0
t/0
Functions
default_value/1
new/4
new!/4
Ash.Query.Calculation
Summary
Types
t/0
Functions
from_resource_calculation/3
from_resource_calculation!/3
new/6
Ash.Resource.Preparation
Summary
Types
ref/0
t/0
Callbacks
init/1
prepare/3
Ash.Resource.Preparation.Builtins
Summary
Functions
after_action/1
before_action/1
build/1
set_context/1
Changes
Ash.Resource.Change
Summary
Types
context/0
ref/0
t/0
Callbacks
after_batch/3
atomic/3
atomic?/0
batch_callbacks?/3
batch_change/3
before_batch/3
change/3
has_after_batch?/0
has_batch_change?/0
has_before_batch?/0
has_change?/0
init/1
.Builtins
Summary
Functions
after_action/2
after_transaction/2
atomic_update/3
before_action/2
before_transaction/2
cascade_destroy/2
cascade_update/2
debug_log/1
ensure_selected/1
filter/1
get_and_lock/2
get_and_lock_for_update/1
increment/2
load/1
manage_relationship/3
optimistic_lock/1
prevent_change/1
relate_actor/2
select/1
set_attribute/3
set_context/1
set_new_attribute/2
update_change/2
Validations
Ash.Resource.Validation
Summary
Types
path/0
ref/0
t/0
Callbacks
atomic/3
atomic?/0
describe/1
has_validate?/0
init/1
validate/3
Functions
action_schema/0
opt_schema/0
validation_type/0
.Builtins
Summary
Functions
absent/2
action_is/1
argument_does_not_equal/2
argument_equals/2
argument_in/2
attribute_does_not_equal/2
attribute_equals/2
attribute_in/2
attributes_absent/2
attributes_present/2
changing/2
compare/2
confirm/2
match/2
negate/1
numericality/2
one_of/2
present/2
string_length/2
Authorization
Ash.Authorizer
Summary
Types
context/0
state/0
Callbacks
add_calculations/3
alter_filter/3
alter_results/3
check/2
check_context/1
exception/2
initial_state/4
strict_check/2
strict_check_context/1
Functions
add_calculations/4
alter_filter/4
alter_results/4
alter_sort/4
check/3
check_context/2
exception/3
initial_state/5
strict_check/3
strict_check_context/2
Ash.Policy.Check
Summary
Types
actor/0
authorizer/0
check_type/0
options/0
ref/0
t/0
Callbacks
auto_filter/3
check/4
describe/1
eager_evaluate?/0
expand_description/3
prefer_expanded_description?/0
requires_original_data?/2
strict_check/3
type/0
Functions
defines_auto_filter?/1
defines_check?/1
Ash.Policy.FilterCheck
Summary
Types
context/0
options/0
Callbacks
filter/3
reject/3
Functions
is_filter_check?/1
Ash.Policy.SimpleCheck
Sections
Example
Summary
Types
actor/0
context/0
options/0
Callbacks
match?/3
Ash.Policy.Check
.Builtins
Summary
Functions
accessing_from/2
action/1
action_type/1
actor_absent/0
actor_attribute_equals/2
actor_present/0
always/0
changing_attributes/1
changing_relationship/1
changing_relationships/1
context_equals/2
filtering_on/2
just_created_with_action/1
loading/1
matches/2
never/0
relates_to_actor_via/2
relating_to_actor/1
resource/1
selecting/1
Extensions
Ash.DataLayer.Ets
Summary
Functions
do_add_calculations/4
ets/1
stop/2
Ash.DataLayer.Mnesia
Summary
Functions
mnesia/1
start/2
Ash.DataLayer.Simple
Summary
Functions
bulk_create/3
set_data/2
Ash.Notifier.PubSub
Sections
Example
Debugging PubSub
Topic Templates
Important
Template parts
Custom Delimiters
Named Pubsub modules
Broadcast Types
Summary
Functions
pub_sub/1
to_payload/4
Ash.Policy.Authorizer
Summary
Types
t/0
Functions
alter_sort/3
expr_check/1
field_policies/1
install/5
policies/1
print_tuple_boolean/1
template_var/1
Ash.Reactor
Summary
Types
action/0
Functions
ash/1
Ash.Resource
Summary
Types
record/0
t/0
Functions
get_metadata/2
loaded?/3
put_metadata/3
selected?/3
set_metadata/2
unload/2
unload_many/2
Introspection
Ash.DataLayer.Ets.Info
Summary
Functions
private?/1
table/1
Ash.DataLayer.Mnesia.Info
Summary
Functions
table/1
Ash.Domain.Dsl.ResourceReference
Summary
Types
t/0
Ash.Domain.Info
Summary
Functions
allow/1
allow_unregistered?/1
authorize/1
depend_on_resources/1
description/1
find_manage_relationships_with_identity_not_configured/1
related_domain/3
require_actor?/1
resource/2
resource_references/1
resources/1
short_name/1
span_name/3
telemetry_event_name/2
timeout/1
trace_name/1
Ash.Notifier.PubSub.Info
Summary
Functions
broadcast_type/1
delimiter/1
filter/1
module/1
name/1
prefix/1
publications/1
transform/1
Ash.Notifier.PubSub.Publication
Summary
Functions
publish_all_schema/0
schema/0
Ash.Policy.FieldPolicy
Summary
Types
t/0
Ash.Policy.Info
Summary
Functions
default_access_type/1
describe_resource/2
field_policies/1
field_policies_for_field/2
log_policy_breakdowns/0
log_successful_policy_breakdowns/0
policies/2
private_fields_policy/1
show_policy_breakdowns?/0
strict_check/3
Ash.Policy.Policy
Summary
Types
t/0
Functions
at_least_one_policy_expression/1
fetch_fact/2
fetch_or_strict_check_fact/2
solve/1
Ash.Resource.Actions
Summary
Types
action/0
action_type/0
Ash.Resource.Actions.Action
Summary
Types
t/0
Functions
transform/1
Ash.Resource.Actions.Argument
Summary
Types
t/0
Functions
schema/0
Ash.Resource.Actions.Create
Summary
Types
t/0
Ash.Resource.Actions.Destroy
Summary
Types
t/0
Functions
transform/1
Ash.Resource.Actions.Implementation
Summary
Callbacks
run/3
Ash.Resource.Actions.Implementation.Context
Summary
Types
t/0
Ash.Resource.Actions.Metadata
Summary
Types
t/0
Functions
schema/0
Ash.Resource.Actions.Read
Summary
Types
t/0
Functions
pagination_schema/0
transform/1
Ash.Resource.Actions.Read.Pagination
Summary
Types
t/0
Functions
transform/1
Ash.Resource.Actions.Update
Summary
Types
t/0
Functions
transform/1
Ash.Resource.Aggregate
Summary
Types
t/0
Ash.Resource.Aggregate.CustomAggregate
Summary
Types
t/0
Callbacks
describe/1
Ash.Resource.Aggregate.JoinFilter
Ash.Resource.Attribute
Summary
Types
t/0
Functions
create_timestamp_schema/0
integer_primary_key_schema/0
transform/1
update_timestamp_schema/0
uuid_primary_key_schema/0
uuid_v7_primary_key_schema/0
Ash.Resource.Calculation.Argument
Summary
Types
t/0
Functions
schema/0
Ash.Resource.Calculation.Context
Summary
Types
t/0
Ash.Resource.Calculation.LoadAttribute
Summary
Functions
calculate/3
describe/1
has_calculate?/0
has_expression?/0
init/1
load/3
strict_loads?/0
Ash.Resource.Calculation.LoadRelationship
Summary
Functions
calculate/3
describe/1
has_calculate?/0
has_expression?/0
init/1
load/3
strict_loads?/0
Ash.Resource.CalculationInterface
Summary
Types
t/0
Functions
schema/0
transform/1
Ash.Resource.Identity
Summary
Types
t/0
Functions
schema/0
Ash.Resource.Info
Summary
Functions
action/3
action_input?/3
action_inputs/2
action_select/2
actions/1
aggregate/2
aggregate_type/2
aggregates/1
always_selected_attribute_names/1
attribute/2
attribute_names/1
attributes/1
attributes_to_require/1
attributes_to_require/2
authorizers/1
base_filter/1
calculation/2
calculation_interface/2
calculation_interfaces/1
calculations/1
changes/1
changes/2
code_interface_domain/1
data_layer/1
default_actions/1
default_context/1
define_interface?/1
description/1
domain/1
embedded?/1
field/2
fields/2
identities/1
identity/2
interface/2
interfaces/1
lazy_matching_default_attributes/2
lazy_non_matching_default_attributes/2
multitenancy_attribute/1
multitenancy_global?/1
multitenancy_parse_attribute/1
multitenancy_strategy/1
multitenancy_template/1
notifiers/1
plural_name/1
preparations/1
primary_action/2
primary_action!/2
primary_key/1
primary_key_simple_equality?/1
public_aggregate/2
public_aggregates/1
public_attribute/2
public_attributes/1
public_calculation/2
public_calculations/1
public_field/2
public_fields/1
public_relationship/2
public_relationships/1
related/2
relationship/2
relationships/1
required_belongs_to_relationships/1
resource?/1
reverse_relationship/3
selected_by_default_attribute_names/1
short_name/1
simple_notifiers/1
sortable?/3
static_default_attributes/2
trace_name/1
unique_keys/1
validations/1
validations/2
Ash.Resource.Interface
Summary
Types
t/0
Functions
calculate_opts/0
create_opts/0
destroy_opts/0
generic_action_opts/0
get_opts/0
read_opts/0
update_opts/0
Ash.Resource.Relationships
Summary
Types
cardinality/0
relationship/0
type/0
Ash.Resource.Relationships.BelongsTo
Summary
Types
t/0
Ash.Resource.Relationships.HasMany
Summary
Types
t/0
Functions
manual/1
transform/1
Ash.Resource.Relationships.HasOne
Summary
Types
t/0
Functions
transform/1
Ash.Resource.Relationships.ManyToMany
Summary
Types
t/0
Utilities
Ash.Changeset.ManagedRelationshipHelpers
Summary
Functions
could_create?/1
could_handle_missing?/1
could_lookup?/1
could_update?/1
must_load?/2
on_lookup_read_action/2
on_lookup_update_action/2
on_match_destination_actions/2
on_missing_destination_actions/2
on_no_match_destination_actions/2
sanitize_opts/2
Ash.CiString
Summary
Types
casing/0
string_type/0
t/0
Functions
compare/2
new/2
sigil_i/2
to_comparable_string/1
value/1
Ash.Expr
Summary
Types
t/0
Functions
actor/1
arg/1
atomic_ref/1
can_return_nil?/1
context/1
determine_type/1
determine_types/4
eval/2
eval!/2
expr/1
expr?/1
or_where/2
parent/1
ref/1
ref/2
template_references?/2
template_references_argument?/1
template_references_context?/1
where/2
Ash.Filter
Sections
Security Concerns
Writing a filter
Summary
Types
t/0
Functions
add_to_filter/6
add_to_filter!/6
builtin_functions/0
builtin_operators/0
builtin_predicate_operators/0
builtins/0
custom_expression/2
do_hydrate_refs/2
fetch_simple_equality_predicate/2
find/5
find_simple_equality_predicate/2
find_value/2
flat_map/2
get_filter/2
get_function/3
get_operator/1
get_predicate_function/3
hydrate_refs/2
list_predicates/1
list_refs/5
map/2
move_exprs_to_relationship_path/2
move_to_relationship_path/2
parse/3
parse!/3
parse_input/2
parse_input!/2
prefix_refs/2
put_at_path/2
relationship_paths/4
run_other_data_layer_filters/4
strict_subset_of/2
strict_subset_of?/2
to_simple_filter/2
used_aggregates/3
used_calculations/6
Ash.Filter.Runtime
Summary
Functions
filter_matches/4
old_get_related/6
Ash.Filter.Simple
Ash.Filter.Simple.Not
Ash.ForbiddenField
Summary
Types
field_type/0
t/0
Ash.Mix.Tasks.Helpers
Summary
Functions
domains!/1
extensions!/2
Ash.NotLoaded
Summary
Types
t/0
Ash.OptionsHelpers
Summary
Functions
ash_resource/0
ash_type/0
hide_all_except/2
Ash.Page
Summary
Types
page/0
type/0
Ash.Page.Keyset
Summary
Types
page_opts/0
page_opts_opts/0
page_opts_type/0
t/0
Functions
data_with_keyset/3
filter/4
new/6
non_executable_binary_to_term/2
Ash.Page.Offset
Summary
Types
page_opts/0
page_opts_opts/0
page_opts_type/0
t/0
Functions
new/5
Ash.PlugHelpers
Summary
Functions
get_actor/1
get_context/1
get_tenant/1
set_actor/2
set_context/2
set_tenant/2
update_actor/2
update_context/2
Ash.ProcessHelpers
Summary
Functions
async/2
get_context_for_transfer/1
task_with_timeout/5
transfer_context/2
Ash.Resource.Builder
Summary
Functions
add_action/4
add_aggregate/5
add_attribute/4
add_calculation/5
add_calculation_interface/3
add_change/3
add_create_timestamp/3
add_identity/4
add_interface/3
add_new_action/4
add_new_aggregate/5
add_new_attribute/4
add_new_calculation/5
add_new_calculation_interface/3
add_new_create_timestamp/3
add_new_identity/4
add_new_interface/3
add_new_relationship/5
add_new_update_timestamp/3
add_preparation/3
add_relationship/5
add_update_timestamp/3
build_action/3
build_action_argument/3
build_action_change/2
build_action_metadata/3
build_action_validation/2
build_aggregate/4
build_attribute/3
build_calculation/4
build_calculation_argument/3
build_calculation_interface/2
build_change/2
build_create_timestamp/2
build_identity/3
build_interface/2
build_pagination/1
build_preparation/2
build_relationship/4
build_update_timestamp/2
prepend_action/4
Ash.SatSolver
Summary
Functions
b/1
left_excludes_right/2
left_implies_right/2
mutually_exclusive/2
mutually_exclusive_and_collectively_exhaustive/1
mutually_inclusive/2
right_excludes_left/2
right_implies_left/2
strict_filter_subset/2
synonymous_relationship_paths?/4
to_cnf/1
transform/2
transform_and_solve/2
Ash.Sort
Summary
Types
sort_item/0
sort_order/0
t/0
Functions
expr_sort/2
parse_input/3
parse_input!/3
parse_sort/4
reverse/1
runtime_sort/3
Ash.UUID
Summary
Functions
generate/0
Ash.UUIDv7
Sections
Examples
Summary
Types
raw/0
t/0
Functions
bingenerate/0
decode/1
encode/1
extract_timestamp/1
generate/0
Ash.Union
Summary
Types
t/0
Ash.Vector
Summary
Types
t/0
Functions
from_binary/1
new/1
to_binary/1
to_list/1
Visualizations
Ash.Domain.Info.Diagram
Sections
Limitations
Summary
Functions
mermaid_class_diagram/2
mermaid_er_diagram/2
Ash.Domain.Info.Livebook
Summary
Functions
action_header/0
action_input_section/2
action_section/2
attr_header/0
attr_section/1
domain_section/1
overview/1
resource_section/1
Ash.Policy.Chart.Mermaid
Summary
Functions
chart/1
Testing
Ash.Generator
Sections
Using Ash.Generator
About Generators
Summary
Types
overrides/0
stream_data/0
Functions
action_input/3
changeset/4
changeset_generator/3
generate/1
generate_many/2
initialize_once/1
initialize_sequence/1
many_changesets/5
many_queries/5
mixed_map/2
next_in_sequence/3
once/2
query/4
seed!/2
seed_generator/2
seed_input/2
seed_many!/3
sequence/3
stop_once/1
stop_sequence/1
Ash.Seed
Summary
Functions
keep_nil/0
seed!/1
seed!/3
update!/2
upsert!/2
upsert!/3
Ash.Test
Summary
Functions
assert_has_error/4
refute_has_error/4
strip_metadata/1
Tracing
Ash.Tracer
Summary
Types
metadata/0
span_type/0
t/0
Callbacks
get_span_context/0
set_error/1
set_error/2
set_handled_error/2
set_metadata/2
set_span_context/1
start_span/2
stop_span/0
trace_type?/1
Functions
get_span_context/1
set_error/2
set_error/3
set_handled_error/3
set_metadata/3
set_span_context/2
span/4
start_span/3
stop_span/1
telemetry_span/4
trace_type?/2
Ash.Tracer.Simple
Summary
Functions
gather_spans/0
Ash.Tracer.Simple.Span
Types
Ash.Type
Sections
Built in types
Lists/Arrays
Defining Custom Types
Composite Types
Constraints
Summary
Types
constraints/0
error/0
load_context/0
merge_load_context/0
t/0
Callbacks
apply_atomic_constraints/2
apply_atomic_constraints_array/2
apply_constraints/2
apply_constraints_array/2
array_constraints/0
can_load?/1
cast_atomic/2
cast_atomic_array/2
cast_in_query?/1
cast_input/2
cast_input_array/2
cast_stored/2
cast_stored_array/2
coerce/2
composite?/1
composite_types/1
constraints/0
custom_apply_constraints_array?/0
describe/1
dump_to_embedded/2
dump_to_embedded_array/2
dump_to_native/2
dump_to_native_array/2
ecto_type/0
embedded?/0
equal?/2
evaluate_operator/1
generator/1
get_rewrites/4
handle_change/3
handle_change_array/3
handle_change_array?/0
include_source/2
init/1
load/4
loaded?/4
matches_type?/2
may_support_atomic_update?/1
merge_load/4
operator_overloads/0
prepare_change/3
prepare_change_array/3
prepare_change_array?/0
rewrite/3
simple_equality?/0
storage_type/0
storage_type/1
Functions
apply_atomic_constraints/3
apply_constraints/3
array_constraints/1
ash_type?/1
builtin?/1
can_load?/2
cast_atomic/3
cast_in_query?/2
cast_input/3
cast_stored/3
coerce/3
composite?/2
composite_types/2
constraints/1
describe/2
determine_types/2
dump_to_embedded/3
dump_to_native/3
ecto_type/1
embedded_type?/1
equal?/3
generator/2
get_rewrites/5
get_type/1
get_type!/1
handle_change/4
handle_change_array?/1
include_source/3
init/2
load/5
loaded?/5
matches_type?/3
merge_load/5
prepare_change/4
prepare_change_array?/1
rewrite/4
short_names/0
simple_equality?/1
storage_type/2
Ash.Type.Atom
Summary
Functions
handle_change?/0
prepare_change?/0
Ash.Type.Binary
Summary
Functions
handle_change?/0
prepare_change?/0
Ash.Type.Boolean
Summary
Functions
handle_change?/0
prepare_change?/0
Ash.Type.CiString
Summary
Functions
handle_change?/0
match/1
prepare_change?/0
Ash.Type.Comparable
Summary
Functions
defcomparable/3
Ash.Type.Date
Summary
Functions
handle_change?/0
prepare_change?/0
Ash.Type.DateTime
Summary
Functions
handle_change?/0
prepare_change?/0
Ash.Type.Decimal
Summary
Functions
handle_change?/0
prepare_change?/0
Ash.Type.DurationName
Summary
Types
t/0
Functions
handle_change?/0
prepare_change?/0
Ash.Type.Enum
Sections
Custom input values
Value descriptions
Summary
Callbacks
description/1
match/1
match?/1
values/0
Ash.Type.File
Sections
Valid values to cast
Summary
Types
t/0
Functions
from_io/1
from_path/1
handle_change?/0
open/2
path/1
prepare_change?/0
Ash.Type.File.Implementation
Summary
Types
error/0
source/0
t/0
Callbacks
open/2
path/1
Ash.Type.File.Source
Sections
Usage
Summary
Types
t/0
Functions
implementation/1
Ash.Type.Float
Summary
Functions
handle_change?/0
prepare_change?/0
Ash.Type.Function
Summary
Functions
handle_change?/0
prepare_change?/0
Ash.Type.Integer
Summary
Functions
handle_change?/0
prepare_change?/0
Ash.Type.Keyword
Summary
Functions
handle_change?/0
prepare_change?/0
Ash.Type.Map
Summary
Functions
handle_change?/0
prepare_change?/0
Ash.Type.Module
Summary
Functions
handle_change?/0
prepare_change?/0
Ash.Type.NaiveDatetime
Summary
Functions
handle_change?/0
prepare_change?/0
Ash.Type.NewType
Sections
Options
Summary
Types
t/0
Callbacks
subtype_constraints/0
subtype_of/0
type_constraints/2
Functions
constraints/2
new_type?/1
subtype_of/1
Ash.Type.String
Summary
Functions
handle_change?/0
prepare_change?/0
Ash.Type.Struct
Sections
Constraints
Summary
Functions
handle_change?/0
prepare_change?/0
Ash.Type.Term
Summary
Functions
handle_change?/0
prepare_change?/0
Ash.Type.Time
Summary
Functions
handle_change?/0
prepare_change?/0
Ash.Type.UUID
Summary
Functions
handle_change?/0
prepare_change?/0
Ash.Type.UUIDv7
Summary
Functions
handle_change?/0
prepare_change?/0
Ash.Type.Union
Sections
Constraints
Summary
Functions
handle_change?/0
prepare_change?/0
Ash.Type.UrlEncodedBinary
Summary
Functions
handle_change?/0
prepare_change?/0
Ash.Type.UtcDatetime
Summary
Functions
handle_change?/0
prepare_change?/0
Ash.Type.UtcDatetimeUsec
Summary
Functions
handle_change?/0
prepare_change?/0
Ash.Type.Vector
Summary
Functions
handle_change?/0
prepare_change?/0
Errors
Ash.Error
Summary
Types
ash_error/0
ash_error_subject/0
class/0
class_module/0
error_class/0
error_input/0
error_keyword/0
error_keyword_option/0
path/0
path_input/0
t/0
Functions
ash_error?/1
error_descriptions/1
set_path/2
splode_error?/2
to_ash_error/3
to_error_class/2
unwrap!/2
.Action.InvalidArgument
Summary
Functions
exception/1
.Changes.ActionRequiresActor
Summary
Functions
exception/1
.Changes.InvalidArgument
Summary
Functions
exception/1
.Changes.InvalidAttribute
Summary
Functions
exception/1
.Changes.InvalidChanges
Summary
Functions
exception/1
.Changes.InvalidRelationship
Summary
Functions
exception/1
.Changes.NoSuchAttribute
Summary
Functions
exception/1
.Changes.NoSuchRelationship
Summary
Functions
exception/1
.Changes.Required
Summary
Functions
exception/1
.Changes.StaleRecord
Summary
Functions
exception/1
.Exception
Summary
Functions
def_ash_error/2
.Forbidden
Summary
Types
t/0
Functions
exception/1
message/1
.Forbidden.CannotFilterCreates
Summary
Functions
exception/1
.Forbidden.DomainRequiresActor
Summary
Functions
exception/1
.Forbidden.DomainRequiresAuthorization
Summary
Functions
exception/1
.Forbidden.ForbiddenField
Summary
Functions
exception/1
.Forbidden.InitialDataRequired
Summary
Functions
exception/1
.Forbidden.MustPassStrictCheck
Summary
Functions
exception/1
.Forbidden.Placeholder
Summary
Functions
exception/1
.Forbidden.Policy
Summary
Functions
exception/1
get_breakdown/4
report/1
report/2
.Framework
Summary
Types
t/0
Functions
exception/1
message/1
.Framework.AssumptionFailed
Summary
Functions
exception/1
.Framework.CanNotBeAtomic
Summary
Functions
exception/1
.Framework.FlagAssertionFailed
Summary
Functions
exception/1
.Framework.InvalidReturnType
Summary
Functions
exception/1
.Framework.MustBeAtomic
Summary
Functions
exception/1
.Framework.SynchronousEngineStuck
Summary
Functions
exception/1
.Invalid
Summary
Types
t/0
Functions
exception/1
message/1
.Invalid.ActionRequiresPagination
Summary
Functions
exception/1
.Invalid.AtomicsNotSupported
Summary
Functions
exception/1
.Invalid.InvalidActionType
Summary
Functions
exception/1
.Invalid.InvalidPrimaryKey
Summary
Functions
exception/1
.Invalid.LimitRequired
Summary
Functions
exception/1
.Invalid.MultipleResults
Summary
Functions
exception/1
.Invalid.NoIdentityFound
Summary
Functions
exception/1
.Invalid.NoMatchingBulkStrategy
Summary
Functions
exception/1
.Invalid.NoPrimaryAction
Summary
Functions
exception/1
.Invalid.NoSuchAction
Summary
Functions
exception/1
.Invalid.NoSuchInput
Summary
Functions
exception/1
.Invalid.NoSuchResource
Summary
Functions
exception/1
.Invalid.NonCountableAction
Summary
Functions
exception/1
.Invalid.NonStreamableAction
Summary
Functions
exception/1
.Invalid.PaginationRequired
Summary
Functions
exception/1
.Invalid.ResourceNotAllowed
Summary
Functions
exception/1
.Invalid.TenantRequired
Summary
Functions
exception/1
.Invalid.Timeout
Summary
Functions
exception/1
.Invalid.TimeoutNotSupported
Summary
Functions
exception/1
.Invalid.Unavailable
Summary
Functions
exception/1
.Load.InvalidQuery
Summary
Functions
exception/1
.Load.NoSuchRelationship
Summary
Functions
exception/1
.Page.InvalidKeyset
Summary
Functions
exception/1
.Query.AggregatesNotSupported
Summary
Functions
exception/1
.Query.CalculationRequiresPrimaryKey
Summary
Functions
exception/1
.Query.CalculationsNotSupported
Summary
Functions
exception/1
.Query.InvalidArgument
Summary
Functions
exception/1
.Query.InvalidCalculationArgument
Summary
Functions
exception/1
.Query.InvalidExpression
Summary
Functions
exception/1
.Query.InvalidFilterReference
Summary
Functions
exception/1
.Query.InvalidFilterValue
Summary
Functions
exception/1
.Query.InvalidLimit
Summary
Functions
exception/1
.Query.InvalidLoad
Summary
Functions
exception/1
.Query.InvalidOffset
Summary
Functions
exception/1
.Query.InvalidPage
Summary
Functions
exception/1
.Query.InvalidQuery
Summary
Functions
exception/1
.Query.InvalidSortOrder
Summary
Functions
exception/1
.Query.LockNotSupported
Summary
Functions
exception/1
.Query.NoComplexSortsWithKeysetPagination
Summary
Functions
exception/1
.Query.NoReadAction
Summary
Functions
exception/1
.Query.NoSuchAttribute
Summary
Functions
exception/1
.Query.NoSuchField
Summary
Functions
exception/1
.Query.NoSuchFilterPredicate
Summary
Functions
exception/1
.Query.NoSuchFunction
Summary
Functions
exception/1
.Query.NoSuchOperator
Summary
Functions
exception/1
.Query.NoSuchRelationship
Summary
Functions
exception/1
.Query.NotFound
Summary
Functions
exception/1
.Query.ReadActionRequired
Summary
Functions
exception/1
.Query.ReadActionRequiresActor
Summary
Functions
exception/1
.Query.Required
Summary
Functions
exception/1
.Query.UnsortableField
Summary
Functions
exception/1
.Query.UnsupportedPredicate
Summary
Functions
exception/1
.SimpleDataLayer.NoDataProvided
Summary
Functions
exception/1
.Stacktrace
Summary
Types
t/0
.Unknown
Summary
Types
t/0
Functions
exception/1
message/1
.Unknown.UnknownError
Summary
Types
t/0
Functions
exception/1
DSL Transformers
Ash.DataLayer.Verifiers.RequirePreCheckWith
Ash.Notifier.PubSub.Verifiers.VerifyActionNames
Summary
Functions
verify/1
Ash.Domain.Verifiers
.EnsureNoEmbeds
.ValidateArgumentsToCodeInterface
.ValidateRelatedResourceInclusion
Ash.Policy.Authorizer
.Transformers.AddMissingFieldPolicies
Summary
Functions
after?/1
after_compile?/0
before?/1
transform/1
.Transformers.CacheFieldPolicies
Summary
Functions
after?/1
after_compile?/0
before?/1
transform/1
Ash.Resource.Transformers
.AttributesByName
Summary
Functions
after?/1
after_compile?/0
before?/1
transform/1
.BelongsToAttribute
Summary
Functions
after?/1
after_compile?/0
before?/1
transform/1
.CacheActionInputs
Summary
Functions
after?/1
after_compile?/0
before?/1
transform/1
.CacheCalculations
Summary
Functions
after?/1
after_compile?/0
before?/1
transform/1
.CachePrimaryKey
Summary
Functions
after?/1
after_compile?/0
before?/1
transform/1
.CacheRelationships
Summary
Functions
after?/1
after_compile?/0
before?/1
transform/1
.CacheUniqueKeys
Summary
Functions
after?/1
after_compile?/0
before?/1
transform/1
.CreateJoinRelationship
Summary
Functions
after?/1
after_compile?/0
before?/1
transform/1
.DefaultAccept
Summary
Functions
after?/1
after_compile?/0
before?/1
transform/1
.GetByReadActions
Summary
Functions
after_compile?/0
.HasDestinationField
Summary
Functions
after?/1
after_compile?/0
before?/1
transform/1
.ManyToManyDestinationAttributeOnJoinResource
Summary
Functions
after?/1
after_compile?/0
before?/1
transform/1
.ManyToManySourceAttributeOnJoinResource
Summary
Functions
after?/1
after_compile?/0
before?/1
transform/1
.RequireUniqueActionNames
Summary
Functions
after?/1
after_compile?/0
before?/1
transform/1
.RequireUniqueFieldNames
Summary
Functions
after?/1
after_compile?/0
before?/1
transform/1
.SetPrimaryActions
Summary
Functions
after?/1
after_compile?/0
before?/1
transform/1
.SetRelationshipSource
Summary
Functions
after?/1
after_compile?/0
before?/1
transform/1
.ValidationsAndChangesForType
Summary
Functions
after?/1
after_compile?/0
before?/1
transform/1
Ash.Resource.Verifiers
.EnsureAggregateFieldIsAttributeOrCalculation
Summary
Functions
verify/1
.NoReservedFieldNames
Summary
Functions
verify/1
.ValidateAccept
.ValidateActionTypesSupported
.ValidateAggregatesSupported
.ValidateArgumentsToCodeInterface
Summary
Functions
verify_interface!/4
.ValidateEagerIdentities
.ValidateManagedRelationshipOpts
.ValidateMultitenancy
.ValidatePrimaryKey
.ValidateRelationshipAttributes
.ValidateRelationshipAttributesMatch
Summary
Functions
verify/1
.VerifyActionsAtomic
Summary
Functions
verify/1
.VerifyGenericActionReactorInputs
Summary
Functions
verify/1
.VerifyIdentityFields
Summary
Functions
verify/1
.VerifyPrimaryKeyPresent
Summary
Functions
verify/1
.VerifyPrimaryReadActionHasNoArguments
Summary
Functions
verify/1
.VerifyReservedCalculationArguments
Summary
Functions
verify/1
.VerifySelectedByDefault
Summary
Functions
verify/1
Expressions
Ash.Filter.Predicate
Summary
Types
comparison/0
predicate/0
Callbacks
bulk_compare/1
compare/2
simplify/1
Functions
compare/2
Ash.Query.BooleanExpression
Summary
Functions
new/3
optimized_new/3
Ash.Query.Call
Ash.Query.Exists
Summary
Functions
can_return_nil?/1
new/3
Ash.Query.Function
Summary
Types
arg/0
Callbacks
args/0
can_return_nil?/1
eager_evaluate?/0
evaluate/1
evaluate_nil_inputs?/0
name/0
new/1
partial_evaluate/1
predicate?/0
private?/0
returns/0
Functions
evaluate/1
new/2
ordinal/1
try_cast_arguments/2
Ash.Query.Not
Summary
Functions
new/1
Ash.Query.Operator
Summary
Callbacks
can_return_nil?/1
evaluate/1
evaluate_nil_inputs?/0
new/2
predicate?/0
returns/0
to_string/2
types/0
Functions
evaluate/1
new/3
operator_overloads/1
operator_symbols/0
operators/0
Ash.Query.Parent
Summary
Functions
new/1
Ash.Query.Ref
Summary
Functions
name/1
Ash.Query.Function
.Ago
Summary
Functions
args/0
.At
Summary
Functions
args/0
.CompositeType
Summary
Functions
args/0
.Contains
Summary
Functions
args/0
.CountNils
Summary
Functions
args/0
.DateAdd
Summary
Functions
args/0
.DateTimeAdd
Summary
Functions
args/0
.Error
Summary
Functions
args/0
.Fragment
Summary
Functions
args/0
casted_new/1
.FromNow
Summary
Functions
args/0
.GetPath
Summary
Functions
args/0
.If
Summary
Functions
args/0
partial_evaluate/1
.IsNil
Summary
Functions
args/0
.Lazy
Summary
Functions
args/0
.Length
Summary
Functions
args/0
.Minus
Summary
Functions
args/0
.Now
Summary
Functions
args/0
.Round
Summary
Functions
args/0
.StartOfDay
Summary
Functions
args/0
.StringDowncase
Summary
Functions
args/0
.StringJoin
Summary
Functions
args/0
.StringLength
Summary
Functions
args/0
.StringPosition
Summary
Functions
args/0
.StringSplit
Sections
Options
Summary
Functions
args/0
.StringTrim
Summary
Functions
args/0
.Today
Summary
Functions
args/0
.Type
Summary
Functions
args/0
Ash.Query.Operator
.Eq
Summary
Functions
evaluate/1
name/0
operator/0
.GreaterThan
Summary
Functions
evaluate/1
name/0
operator/0
.GreaterThanOrEqual
Summary
Functions
evaluate/1
name/0
operator/0
.In
Summary
Functions
evaluate/1
name/0
operator/0
.IsNil
Summary
Functions
name/0
operator/0
.LessThan
Summary
Functions
evaluate/1
name/0
operator/0
.LessThanOrEqual
Summary
Functions
evaluate/1
name/0
operator/0
.NotEq
Summary
Functions
evaluate/1
name/0
operator/0
Builtins
Ash.Policy.Check
.AccessingFrom
Summary
Functions
eager_evaluate?/0
prefer_expanded_description?/0
strict_check/3
type/0
.Action
Summary
Functions
eager_evaluate?/0
prefer_expanded_description?/0
strict_check/3
type/0
.ActionType
Summary
Functions
eager_evaluate?/0
prefer_expanded_description?/0
strict_check/3
type/0
.ActorAbsent
Summary
Functions
eager_evaluate?/0
prefer_expanded_description?/0
strict_check/3
type/0
.ActorAttributeEquals
Summary
Functions
eager_evaluate?/0
prefer_expanded_description?/0
strict_check/3
type/0
.ActorPresent
Summary
Functions
eager_evaluate?/0
prefer_expanded_description?/0
strict_check/3
type/0
.ChangingAttributes
Summary
Functions
auto_filter/3
auto_filter_not/3
check/4
eager_evaluate?/0
expand_description/3
prefer_expanded_description?/0
reject/3
requires_original_data?/2
strict_check/3
strict_check_context/1
type/0
.ChangingRelationships
Summary
Functions
eager_evaluate?/0
prefer_expanded_description?/0
strict_check/3
type/0
.ContextEquals
Summary
Functions
eager_evaluate?/0
prefer_expanded_description?/0
strict_check/3
type/0
.Expression
Summary
Functions
auto_filter/3
auto_filter_not/3
check/4
eager_evaluate?/0
expand_description/3
reject/3
requires_original_data?/2
strict_check/3
strict_check_context/1
type/0
.FilteringOn
Summary
Functions
eager_evaluate?/0
prefer_expanded_description?/0
strict_check/3
type/0
.Loading
Summary
Functions
eager_evaluate?/0
prefer_expanded_description?/0
strict_check/3
type/0
.Matches
Summary
Functions
eager_evaluate?/0
prefer_expanded_description?/0
requires_original_data?/2
strict_check/3
type/0
.RelatesToActorVia
Summary
Functions
auto_filter/3
auto_filter_not/3
check/4
eager_evaluate?/0
expand_description/3
prefer_expanded_description?/0
requires_original_data?/2
strict_check/3
strict_check_context/1
type/0
.RelatingToActor
Summary
Functions
auto_filter/3
auto_filter_not/3
check/4
eager_evaluate?/0
expand_description/3
prefer_expanded_description?/0
reject/3
requires_original_data?/2
strict_check/3
strict_check_context/1
type/0
.Resource
Summary
Functions
eager_evaluate?/0
prefer_expanded_description?/0
strict_check/3
type/0
.Selecting
Summary
Functions
eager_evaluate?/0
prefer_expanded_description?/0
strict_check/3
type/0
.Static
Summary
Functions
eager_evaluate?/0
prefer_expanded_description?/0
strict_check/3
type/0
Ash.Resource.Change
.CascadeDestroy
Sections
Options
Example
.CascadeUpdate
Sections
Options
Example
.Context
Summary
Types
t/0
.GetAndLock
.GetAndLockForUpdate
.Increment
.OptimisticLock
Sections
What is Optimistic Locking?
Ash.Resource.Validation
.ActionIs
.Context
Summary
Types
t/0
Internals
Ash.Actions.Read.AsyncLimiter
Summary
Functions
async_or_inline/4
await_all/1
await_at_least_one/1
child_spec/1
start_link/1
Ash.Can
Summary
Types
subject/0
Functions
can/4
can?/4
Ash.Changeset.OriginalDataNotAvailable
Summary
Types
t/0
Ash.Context
Summary
Types
context_keyword_list/0
Functions
to_opts/2
Ash.CustomExpression
Summary
Callbacks
arguments/0
expression/2
name/0
Ash.Domain.Igniter
Summary
Functions
add_resource_reference/3
list_domains/1
remove_resource_reference/3
Ash.Extension
Summary
Types
argv/0
igniter/0
Callbacks
codegen/1
install/5
migrate/1
reset/1
rollback/1
setup/1
tear_down/1
Ash.Igniter
Summary
Functions
codegen/2
Ash.Policy.PolicyGroup
Ash.Query.UpsertConflict
Summary
Functions
new/1
Ash.Reactor.ActionStep
Ash.Reactor.AshStep
Sections
Options
Ash.Reactor.BulkCreateStep
Ash.Reactor.BulkUpdateStep
Ash.Reactor.ChangeStep
Ash.Reactor.CreateStep
Ash.Reactor.DestroyStep
Ash.Reactor.Dsl.Action
Summary
Types
t/0
Ash.Reactor.Dsl.ActionLoad
Summary
Types
t/0
Ash.Reactor.Dsl.ActionTransformer
Summary
Functions
after?/1
after_compile?/0
Ash.Reactor.Dsl.Actor
Summary
Types
t/0
Ash.Reactor.Dsl.AshStep
Summary
Types
t/0
Ash.Reactor.Dsl.BulkCreate
Summary
Types
t/0
Ash.Reactor.Dsl.BulkUpdate
Summary
Types
t/0
Ash.Reactor.Dsl.Change
Summary
Types
t/0
Ash.Reactor.Dsl.Context
Summary
Types
t/0
Ash.Reactor.Dsl.Create
Summary
Types
t/0
Ash.Reactor.Dsl.Destroy
Summary
Types
t/0
Ash.Reactor.Dsl.Inputs
Summary
Types
t/0
Ash.Reactor.Dsl.Load
Summary
Types
t/0
Ash.Reactor.Dsl.MiddlewareTransformer
Summary
Functions
after?/1
after_compile?/0
Ash.Reactor.Dsl.Read
Summary
Types
t/0
Ash.Reactor.Dsl.ReadOne
Summary
Types
t/0
Ash.Reactor.Dsl.Tenant
Summary
Types
t/0
Ash.Reactor.Dsl.Transaction
Summary
Types
t/0
Ash.Reactor.Dsl.Update
Summary
Types
t/0
Ash.Reactor.LoadStep
Summary
Functions
run/3
Ash.Reactor.MergeInputsStep
Ash.Reactor.Notifications
Summary
Functions
complete/2
enqueue_notifications/2
error/2
halt/1
init/1
publish/2
Ash.Reactor.ReadOneStep
Summary
Functions
run/3
Ash.Reactor.ReadStep
Summary
Functions
run/3
Ash.Reactor.Tracer
Ash.Reactor.TransactionStep
Summary
Functions
run/3
Ash.Reactor.UpdateStep
Ash.Resource.Dsl.Filter
Ash.Resource.Igniter
Sections
Important Details
Summary
Functions
add_action/3
add_attribute/3
add_block/4
add_bypass/4
add_identity/3
add_new_action/4
add_new_attribute/4
add_new_identity/4
add_new_relationship/4
add_policy/4
add_relationship/3
add_resource_configuration/3
defines_action/3
defines_attribute/3
defines_identity/3
defines_relationship/3
domain/2
ensure_primary_action/3
ensure_timestamps/2
has_action_with_primary/3
list_resources/1
resource_mods/1
Ash.Resource.ManualCreate.Context
Summary
Types
t/0
Ash.Resource.ManualDestroy.Context
Summary
Types
t/0
Ash.Resource.ManualRelationship.Context
Summary
Types
t/0
Ash.Resource.ManualUpdate.Context
Summary
Types
t/0
Ash.Resource.Preparation.Context
Summary
Types
t/0
Ash.ToTenant
Summary
Types
t/0
Functions
to_tenant/2
Comp
Summary
Types
left/0
right/0
Functions
compare/2
defcomparable/3
eq/0
equal?/2
greater_or_equal?/2
greater_than?/2
gt/0
less_or_equal?/2
less_than?/2
lt/0
max/2
min/2
not_equal?/2
type_of/1
Comparable
Summary
Types
ord/0
t/0
Functions
compare/1
Comparable.Type.Any.To.Any
Comparable.Type.Ash.CiString.To.Ash.CiString
Comparable.Type.Ash.CiString.To.BitString
Comparable.Type.Atom.To.BitString
Comparable.Type.BitString.To.Ash.CiString
Comparable.Type.BitString.To.Atom
Comparable.Type.BitString.To.Decimal
Comparable.Type.Date.To.Date
Comparable.Type.DateTime.To.DateTime
Comparable.Type.Decimal.To.BitString
Comparable.Type.Decimal.To.Decimal
Comparable.Type.Decimal.To.Float
Comparable.Type.Decimal.To.Integer
Comparable.Type.Float.To.Decimal
Comparable.Type.Integer.To.Decimal
Comparable.Type.List.To.List
Comparable.Type.Map.To.Map
Comparable.Type.NaiveDateTime.To.NaiveDateTime
Comparable.Type.Time.To.Time
Comparable.Type.Tuple.To.Tuple
Internals
mix ash.codegen
Sections
Flags
Summary
Functions
run/1
mix ash.extend
Sections
Example
mix ash.gen.base_resource
Sections
Example
mix ash.gen.domain
Sections
Example
mix ash.gen.enum
Sections
Example
Options
mix ash.gen.resource
Sections
Example
Options
mix ash.generate_livebook
Sections
Command line options
Summary
Functions
run/1
mix ash.generate_policy_charts
Sections
Prerequisites
Command line options
Summary
Functions
run/1
mix ash.generate_resource_diagrams
Sections
Prerequisites
Command line options
Summary
Functions
run/1
mix ash.install
mix ash.migrate
Summary
Functions
run/1
mix ash.patch.extend
mix ash.reset
Summary
Functions
run/1
mix ash.rollback
Summary
Functions
run/1
mix ash.setup
Summary
Functions
run/1
mix ash.tear_down
Summary
Functions
run/1
Search documentation of ash
Settings
Ash.Resource.Change.GetAndLockForUpdate
(ash v3.4.68)
View Source
Refetches the record being updated or destroyed, and locks it for update.