ash-project/ash
1
0
Fork 0
mirror of https://github.com/ash-project/ash.git synced 2024-09-20 05:23:03 +12:00
Code Issues Projects Releases Packages Wiki Activity

chore: update cheat_sheets

Browse source
This commit is contained in:
Zach Daniel 2023-09-20 16:29:47 -04:00
parent 05b9ac1f86
commit 0a1f56d58b
8 changed files with 233 additions and 233 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
documentation/dsls/DSL:-Ash.Api.cheatmd
View file

@ -60,7 +60,7 @@ end
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `allow` | `mfa` | | Support a dynamic resource list by providing a callback that checks whether or not the resource should be allowed. | | `allow` | `mfa` | | Support a dynamic resource list by providing a callback that checks whether or not the resource should be allowed. |
| `allow_unregistered?` | `boolean` | false | Whether the Api will support only registered entries or not. | | `allow_unregistered?` | `boolean` | `false` | Whether the Api will support only registered entries or not. |
| `registry` | `module` | | Configure a registry that contains the resources. This option is generally not necessary anymore, and remains for backwards compatibility. Instead, configure resources in this block directly. | | `registry` | `module` | | Configure a registry that contains the resources. This option is generally not necessary anymore, and remains for backwards compatibility. Instead, configure resources in this block directly. |
@ -118,7 +118,7 @@ end
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `timeout` | `timeout` | 30000 | The default timeout to use for requests using this API. See the [timeouts guide](/documentation/topics/timeouts.md) for more. | | `timeout` | `timeout` | `30000` | The default timeout to use for requests using this API. See the [timeouts guide](/documentation/topics/timeouts.md) for more. |
| `trace_name` | `String.t` | | The name to use in traces. Defaults to the last part of the module. See the [monitoring guide](/documentation/topics/monitoring.md) for more | | `trace_name` | `String.t` | | The name to use in traces. Defaults to the last part of the module. See the [monitoring guide](/documentation/topics/monitoring.md) for more |
@ -146,8 +146,8 @@ end
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `require_actor?` | `boolean` | false | Requires that an actor has been supplied. | | `require_actor?` | `boolean` | `false` | Requires that an actor has been supplied. |
| `authorize` | `:always \| :by_default \| :when_requested` | :when_requested | When to run authorization for a given request. | | `authorize` | `:always \| :by_default \| :when_requested` | `:when_requested` | When to run authorization for a given request. |

2
documentation/dsls/DSL:-Ash.DataLayer.Ets.cheatmd
View file

@ -27,7 +27,7 @@ end
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `private?` | `boolean` | false | Sets the ets table protection to private, and scopes it to only this process. The table name will not be used directly if this is true, to allow multiple processes to use this resource separately. | | `private?` | `boolean` | `false` | Sets the ets table protection to private, and scopes it to only this process. The table name will not be used directly if this is true, to allow multiple processes to use this resource separately. |
| `table` | `atom` | | The name of the table. Defaults to the resource name. | | `table` | `atom` | | The name of the table. Defaults to the resource name. |

34
documentation/dsls/DSL:-Ash.Flow.cheatmd
View file

@ -67,8 +67,8 @@ end
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `default` | `(-> any) \| mfa \| any()` | | A default value to use for the argument if not provided | | `default` | `(-> any) \| mfa \| any()` | | A default value to use for the argument if not provided |
| `allow_nil?` | `boolean` | true | Whether or not the argument value may be nil | | `allow_nil?` | `boolean` | `true` | Whether or not the argument value may be nil |
| `constraints` | `Keyword.t` | [] | Constraints to provide to the type when casting the value. See the type's documentation for more information. | | `constraints` | `Keyword.t` | `[]` | Constraints to provide to the type when casting the value. See the type's documentation for more information. |
@ -155,7 +155,7 @@ end
| `wait_for` | ``any`` | | Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited. | | `wait_for` | ``any`` | | Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited. |
| `touches_resources` | `list(atom)` | | A list of resources touched by any custom logic in this step. This is used in the case that this step is run in a transaction. This is primarily only needed for `custom` steps. | | `touches_resources` | `list(atom)` | | A list of resources touched by any custom logic in this step. This is used in the case that this step is run in a transaction. This is primarily only needed for `custom` steps. |
| `halt_if` | ``any`` | | Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more. | | `halt_if` | ``any`` | | Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more. |
| `halt_reason` | ``any`` | :halted | Configures the reason for the `halt_if` clause. | | `halt_reason` | ``any`` | `:halted` | Configures the reason for the `halt_if` clause. |
| `description` | `String.t` | | A description for the step. | | `description` | `String.t` | | A description for the step. |
@ -207,7 +207,7 @@ end
| `wait_for` | ``any`` | | Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited. | | `wait_for` | ``any`` | | Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited. |
| `touches_resources` | `list(atom)` | | A list of resources touched by any custom logic in this step. This is used in the case that this step is run in a transaction. This is primarily only needed for `custom` steps. | | `touches_resources` | `list(atom)` | | A list of resources touched by any custom logic in this step. This is used in the case that this step is run in a transaction. This is primarily only needed for `custom` steps. |
| `halt_if` | ``any`` | | Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more. | | `halt_if` | ``any`` | | Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more. |
| `halt_reason` | ``any`` | :halted | Configures the reason for the `halt_if` clause. | | `halt_reason` | ``any`` | `:halted` | Configures the reason for the `halt_if` clause. |
| `description` | `String.t` | | A description for the step. | | `description` | `String.t` | | A description for the step. |
@ -265,7 +265,7 @@ end
| `wait_for` | ``any`` | | Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited. | | `wait_for` | ``any`` | | Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited. |
| `touches_resources` | `list(atom)` | | A list of resources touched by any custom logic in this step. This is used in the case that this step is run in a transaction. This is primarily only needed for `custom` steps. | | `touches_resources` | `list(atom)` | | A list of resources touched by any custom logic in this step. This is used in the case that this step is run in a transaction. This is primarily only needed for `custom` steps. |
| `halt_if` | ``any`` | | Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more. | | `halt_if` | ``any`` | | Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more. |
| `halt_reason` | ``any`` | :halted | Configures the reason for the `halt_if` clause. | | `halt_reason` | ``any`` | `:halted` | Configures the reason for the `halt_if` clause. |
| `description` | `String.t` | | A description for the step. | | `description` | `String.t` | | A description for the step. |
@ -304,13 +304,13 @@ create :create_post, MyApp.Post, :create
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `upsert?` | `boolean` | false | Wether or not this action is always an upsert. | | `upsert?` | `boolean` | `false` | Wether or not this action is always an upsert. |
| `upsert_identity` | `atom` | | The identity to use for the upsert. | | `upsert_identity` | `atom` | | The identity to use for the upsert. |
| `short_name` | `String.t` | | Set a short name for the step. Will be used when building things like mermaid charts. | | `short_name` | `String.t` | | Set a short name for the step. Will be used when building things like mermaid charts. |
| `wait_for` | ``any`` | | Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited. | | `wait_for` | ``any`` | | Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited. |
| `touches_resources` | `list(atom)` | | A list of resources touched by any custom logic in this step. This is used in the case that this step is run in a transaction. This is primarily only needed for `custom` steps. | | `touches_resources` | `list(atom)` | | A list of resources touched by any custom logic in this step. This is used in the case that this step is run in a transaction. This is primarily only needed for `custom` steps. |
| `halt_if` | ``any`` | | Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more. | | `halt_if` | ``any`` | | Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more. |
| `halt_reason` | ``any`` | :halted | Configures the reason for the `halt_if` clause. | | `halt_reason` | ``any`` | `:halted` | Configures the reason for the `halt_if` clause. |
| `description` | `String.t` | | A description for the step. | | `description` | `String.t` | | A description for the step. |
| `api` | ``any`` | | The api to use when calling the action. Defaults to the api set in the `flow` section. | | `api` | ``any`` | | The api to use when calling the action. Defaults to the api set in the `flow` section. |
| `tenant` | ``any`` | | A tenant to use for the operation. May be a template or a literal value. | | `tenant` | ``any`` | | A tenant to use for the operation. May be a template or a literal value. |
@ -357,7 +357,7 @@ end
| `short_name` | `String.t` | | Set a short name for the step. Will be used when building things like mermaid charts. | | `short_name` | `String.t` | | Set a short name for the step. Will be used when building things like mermaid charts. |
| `wait_for` | ``any`` | | Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited. | | `wait_for` | ``any`` | | Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited. |
| `halt_if` | ``any`` | | Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more. | | `halt_if` | ``any`` | | Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more. |
| `halt_reason` | ``any`` | :halted | Configures the reason for the `halt_if` clause. | | `halt_reason` | ``any`` | `:halted` | Configures the reason for the `halt_if` clause. |
| `description` | `String.t` | | A description for the step. | | `description` | `String.t` | | A description for the step. |
@ -403,7 +403,7 @@ end
| `wait_for` | ``any`` | | Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited. | | `wait_for` | ``any`` | | Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited. |
| `touches_resources` | `list(atom)` | | A list of resources touched by any custom logic in this step. This is used in the case that this step is run in a transaction. This is primarily only needed for `custom` steps. | | `touches_resources` | `list(atom)` | | A list of resources touched by any custom logic in this step. This is used in the case that this step is run in a transaction. This is primarily only needed for `custom` steps. |
| `halt_if` | ``any`` | | Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more. | | `halt_if` | ``any`` | | Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more. |
| `halt_reason` | ``any`` | :halted | Configures the reason for the `halt_if` clause. | | `halt_reason` | ``any`` | `:halted` | Configures the reason for the `halt_if` clause. |
| `description` | `String.t` | | A description for the step. | | `description` | `String.t` | | A description for the step. |
| `api` | ``any`` | | The api to use when calling the action. Defaults to the api set in the `flow` section. | | `api` | ``any`` | | The api to use when calling the action. Defaults to the api set in the `flow` section. |
| `tenant` | ``any`` | | A tenant to use for the operation. May be a template or a literal value. | | `tenant` | ``any`` | | A tenant to use for the operation. May be a template or a literal value. |
@ -450,7 +450,7 @@ destroy :destroy_post, MyApp.Post, :destroy
| `wait_for` | ``any`` | | Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited. | | `wait_for` | ``any`` | | Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited. |
| `touches_resources` | `list(atom)` | | A list of resources touched by any custom logic in this step. This is used in the case that this step is run in a transaction. This is primarily only needed for `custom` steps. | | `touches_resources` | `list(atom)` | | A list of resources touched by any custom logic in this step. This is used in the case that this step is run in a transaction. This is primarily only needed for `custom` steps. |
| `halt_if` | ``any`` | | Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more. | | `halt_if` | ``any`` | | Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more. |
| `halt_reason` | ``any`` | :halted | Configures the reason for the `halt_if` clause. | | `halt_reason` | ``any`` | `:halted` | Configures the reason for the `halt_if` clause. |
| `description` | `String.t` | | A description for the step. | | `description` | `String.t` | | A description for the step. |
| `api` | ``any`` | | The api to use when calling the action. Defaults to the api set in the `flow` section. | | `api` | ``any`` | | The api to use when calling the action. Defaults to the api set in the `flow` section. |
| `tenant` | ``any`` | | A tenant to use for the operation. May be a template or a literal value. | | `tenant` | ``any`` | | A tenant to use for the operation. May be a template or a literal value. |
@ -501,7 +501,7 @@ end
| `wait_for` | ``any`` | | Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited. | | `wait_for` | ``any`` | | Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited. |
| `touches_resources` | `list(atom)` | | A list of resources touched by any custom logic in this step. This is used in the case that this step is run in a transaction. This is primarily only needed for `custom` steps. | | `touches_resources` | `list(atom)` | | A list of resources touched by any custom logic in this step. This is used in the case that this step is run in a transaction. This is primarily only needed for `custom` steps. |
| `halt_if` | ``any`` | | Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more. | | `halt_if` | ``any`` | | Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more. |
| `halt_reason` | ``any`` | :halted | Configures the reason for the `halt_if` clause. | | `halt_reason` | ``any`` | `:halted` | Configures the reason for the `halt_if` clause. |
| `description` | `String.t` | | A description for the step. | | `description` | `String.t` | | A description for the step. |
| `api` | ``any`` | | The api to use when calling the action. Defaults to the api set in the `flow` section. | | `api` | ``any`` | | The api to use when calling the action. Defaults to the api set in the `flow` section. |
| `tenant` | ``any`` | | A tenant to use for the operation. May be a template or a literal value. | | `tenant` | ``any`` | | A tenant to use for the operation. May be a template or a literal value. |
@ -543,13 +543,13 @@ read :destroy_post, MyApp.Post, :destroy
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `get?` | `boolean` | false | Whether or not read action is expected to return a single result or `nil`. Set to `true` automatically if `get? true`. | | `get?` | `boolean` | `false` | Whether or not read action is expected to return a single result or `nil`. Set to `true` automatically if `get? true`. |
| `not_found_error?` | `boolean` | true | Whether or not finding no record should result in a not found error | | `not_found_error?` | `boolean` | `true` | Whether or not finding no record should result in a not found error |
| `short_name` | `String.t` | | Set a short name for the step. Will be used when building things like mermaid charts. | | `short_name` | `String.t` | | Set a short name for the step. Will be used when building things like mermaid charts. |
| `wait_for` | ``any`` | | Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited. | | `wait_for` | ``any`` | | Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited. |
| `touches_resources` | `list(atom)` | | A list of resources touched by any custom logic in this step. This is used in the case that this step is run in a transaction. This is primarily only needed for `custom` steps. | | `touches_resources` | `list(atom)` | | A list of resources touched by any custom logic in this step. This is used in the case that this step is run in a transaction. This is primarily only needed for `custom` steps. |
| `halt_if` | ``any`` | | Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more. | | `halt_if` | ``any`` | | Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more. |
| `halt_reason` | ``any`` | :halted | Configures the reason for the `halt_if` clause. | | `halt_reason` | ``any`` | `:halted` | Configures the reason for the `halt_if` clause. |
| `description` | `String.t` | | A description for the step. | | `description` | `String.t` | | A description for the step. |
| `api` | ``any`` | | The api to use when calling the action. Defaults to the api set in the `flow` section. | | `api` | ``any`` | | The api to use when calling the action. Defaults to the api set in the `flow` section. |
| `tenant` | ``any`` | | A tenant to use for the operation. May be a template or a literal value. | | `tenant` | ``any`` | | A tenant to use for the operation. May be a template or a literal value. |
@ -599,7 +599,7 @@ run_flow :get_org, GetOrgByName do
| `wait_for` | ``any`` | | Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited. | | `wait_for` | ``any`` | | Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited. |
| `touches_resources` | `list(atom)` | | A list of resources touched by any custom logic in this step. This is used in the case that this step is run in a transaction. This is primarily only needed for `custom` steps. | | `touches_resources` | `list(atom)` | | A list of resources touched by any custom logic in this step. This is used in the case that this step is run in a transaction. This is primarily only needed for `custom` steps. |
| `halt_if` | ``any`` | | Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more. | | `halt_if` | ``any`` | | Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more. |
| `halt_reason` | ``any`` | :halted | Configures the reason for the `halt_if` clause. | | `halt_reason` | ``any`` | `:halted` | Configures the reason for the `halt_if` clause. |
| `description` | `String.t` | | A description for the step. | | `description` | `String.t` | | A description for the step. |
@ -649,12 +649,12 @@ end
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `input` | ``any`` | | A template for the input. | | `input` | ``any`` | | A template for the input. |
| `async?` | `boolean` | false | Whether or not this step can be run outside of the current process. | | `async?` | `boolean` | `false` | Whether or not this step can be run outside of the current process. |
| `short_name` | `String.t` | | Set a short name for the step. Will be used when building things like mermaid charts. | | `short_name` | `String.t` | | Set a short name for the step. Will be used when building things like mermaid charts. |
| `wait_for` | ``any`` | | Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited. | | `wait_for` | ``any`` | | Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited. |
| `touches_resources` | `list(atom)` | | A list of resources touched by any custom logic in this step. This is used in the case that this step is run in a transaction. This is primarily only needed for `custom` steps. | | `touches_resources` | `list(atom)` | | A list of resources touched by any custom logic in this step. This is used in the case that this step is run in a transaction. This is primarily only needed for `custom` steps. |
| `halt_if` | ``any`` | | Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more. | | `halt_if` | ``any`` | | Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more. |
| `halt_reason` | ``any`` | :halted | Configures the reason for the `halt_if` clause. | | `halt_reason` | ``any`` | `:halted` | Configures the reason for the `halt_if` clause. |
| `description` | `String.t` | | A description for the step. | | `description` | `String.t` | | A description for the step. |

2
documentation/dsls/DSL:-Ash.Notifier.PubSub.cheatmd
View file

@ -36,7 +36,7 @@ end
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `module`* | `atom` | | The module to call `broadcast/3` on e.g module.broadcast(topic, event, message). | | `module`* | `atom` | | The module to call `broadcast/3` on e.g module.broadcast(topic, event, message). |
| `prefix` | `String.t` | | A prefix for all pubsub messages, e.g `users`. A message with `created` would be published as `users:created` | | `prefix` | `String.t` | | A prefix for all pubsub messages, e.g `users`. A message with `created` would be published as `users:created` |
| `broadcast_type` | `:notification \| :phoenix_broadcast \| :broadcast` | :notification | What shape the event payloads will be in. See | | `broadcast_type` | `:notification \| :phoenix_broadcast \| :broadcast` | `:notification` | What shape the event payloads will be in. See |
| `name` | `atom` | | A named pub sub to pass as the first argument to broadcast. | | `name` | `atom` | | A named pub sub to pass as the first argument to broadcast. |

2
documentation/dsls/DSL:-Ash.Policy.Authorizer.cheatmd
View file

@ -81,7 +81,7 @@ end
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `default_access_type` | `:strict \| :filter \| :runtime` | :filter | The default access type of policies for this resource. | | `default_access_type` | `:strict \| :filter \| :runtime` | `:filter` | The default access type of policies for this resource. |

2
documentation/dsls/DSL:-Ash.Registry.cheatmd
View file

@ -28,7 +28,7 @@ end
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `warn_on_empty?` | `boolean` | true | Set to `false` to ignore warnings about an empty registry | | `warn_on_empty?` | `boolean` | `true` | Set to `false` to ignore warnings about an empty registry |

412
documentation/dsls/DSL:-Ash.Resource.cheatmd
View file

@ -81,18 +81,18 @@ end
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `constraints` | `Keyword.t` | | Constraints to provide to the type when casting the value. For more, see the [constraints topic](/documentation/topics/constraints.md). | | `constraints` | `Keyword.t` | | Constraints to provide to the type when casting the value. For more, see the [constraints topic](/documentation/topics/constraints.md). |
| `description` | `String.t` | | An optional description for the attribute. | | `description` | `String.t` | | An optional description for the attribute. |
| `sensitive?` | `boolean` | false | Whether or not the attribute value contains sensitive information, like PII. See the [Security guide](/documentation/topics/security.md) for more. | | `sensitive?` | `boolean` | `false` | Whether or not the attribute value contains sensitive information, like PII. See the [Security guide](/documentation/topics/security.md) for more. |
| `source` | `atom` | | If the field should be mapped to a different name in the data layer. Support varies by data layer. | | `source` | `atom` | | If the field should be mapped to a different name in the data layer. Support varies by data layer. |
| `always_select?` | `boolean` | false | Whether or not to ensure this attribute is always selected when reading from the database, regardless of applied select statements. | | `always_select?` | `boolean` | `false` | Whether or not to ensure this attribute is always selected when reading from the database, regardless of applied select statements. |
| `primary_key?` | `boolean` | false | Whether the attribute is the primary key. Composite primary key is also possible by using `primary_key? true` in more than one attribute. If primary_key? is true, allow_nil? must be false. | | `primary_key?` | `boolean` | `false` | Whether the attribute is the primary key. Composite primary key is also possible by using `primary_key? true` in more than one attribute. If primary_key? is true, allow_nil? must be false. |
| `allow_nil?` | `boolean` | true | Whether or not the attribute can be set to nil. If nil value is given error is raised. | | `allow_nil?` | `boolean` | `true` | Whether or not the attribute can be set to nil. If nil value is given error is raised. |
| `generated?` | `boolean` | false | Whether or not the value may be generated by the data layer. | | `generated?` | `boolean` | `false` | Whether or not the value may be generated by the data layer. |
| `writable?` | `boolean` | true | Whether or not the value can be written to. Non-writable attributes can still be written with `Ash.Changeset.force_change_attribute/3`. | | `writable?` | `boolean` | `true` | Whether or not the value can be written to. Non-writable attributes can still be written with `Ash.Changeset.force_change_attribute/3`. |
| `private?` | `boolean` | false | The attribute is not publically writable, and should not be exposed over any public interfaces. See the [security guide](/documentation/topics/security.md) for more. | | `private?` | `boolean` | `false` | The attribute is not publically writable, and should not be exposed over any public interfaces. See the [security guide](/documentation/topics/security.md) for more. |
| `default` | `(-> any) \| mfa \| any()` | | A value to be set on all creates, unless a value is being provided already. | | `default` | `(-> any) \| mfa \| any()` | | A value to be set on all creates, unless a value is being provided already. |
| `update_default` | `(-> any) \| mfa \| any()` | | A value to be set on all updates, unless a value is being provided already. | | `update_default` | `(-> any) \| mfa \| any()` | | A value to be set on all updates, unless a value is being provided already. |
| `filterable?` | `boolean \| :simple_equality` | true | Whether or not the attribute can be referenced in filters. | | `filterable?` | `boolean \| :simple_equality` | `true` | Whether or not the attribute can be referenced in filters. |
| `match_other_defaults?` | `boolean` | false | Ensures that other attributes that use the same "lazy" default (a function or an mfa), use the same default value. Has no effect unless `default` is a zero argument function. | | `match_other_defaults?` | `boolean` | `false` | Ensures that other attributes that use the same "lazy" default (a function or an mfa), use the same default value. Has no effect unless `default` is a zero argument function. |
@ -137,21 +137,21 @@ create_timestamp :inserted_at
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `type` | `module` | Ash.Type.UtcDatetimeUsec | The type of the attribute. See `Ash.Type` for more. | | `type` | `module` | `Ash.Type.UtcDatetimeUsec` | The type of the attribute. See `Ash.Type` for more. |
| `constraints` | `Keyword.t` | | Constraints to provide to the type when casting the value. For more, see the [constraints topic](/documentation/topics/constraints.md). | | `constraints` | `Keyword.t` | | Constraints to provide to the type when casting the value. For more, see the [constraints topic](/documentation/topics/constraints.md). |
| `description` | `String.t` | | An optional description for the attribute. | | `description` | `String.t` | | An optional description for the attribute. |
| `sensitive?` | `boolean` | false | Whether or not the attribute value contains sensitive information, like PII. See the [Security guide](/documentation/topics/security.md) for more. | | `sensitive?` | `boolean` | `false` | Whether or not the attribute value contains sensitive information, like PII. See the [Security guide](/documentation/topics/security.md) for more. |
| `source` | `atom` | | If the field should be mapped to a different name in the data layer. Support varies by data layer. | | `source` | `atom` | | If the field should be mapped to a different name in the data layer. Support varies by data layer. |
| `always_select?` | `boolean` | false | Whether or not to ensure this attribute is always selected when reading from the database, regardless of applied select statements. | | `always_select?` | `boolean` | `false` | Whether or not to ensure this attribute is always selected when reading from the database, regardless of applied select statements. |
| `primary_key?` | `boolean` | false | Whether the attribute is the primary key. Composite primary key is also possible by using `primary_key? true` in more than one attribute. If primary_key? is true, allow_nil? must be false. | | `primary_key?` | `boolean` | `false` | Whether the attribute is the primary key. Composite primary key is also possible by using `primary_key? true` in more than one attribute. If primary_key? is true, allow_nil? must be false. |
| `allow_nil?` | `boolean` | false | Whether or not the attribute can be set to nil. If nil value is given error is raised. | | `allow_nil?` | `boolean` | `false` | Whether or not the attribute can be set to nil. If nil value is given error is raised. |
| `generated?` | `boolean` | false | Whether or not the value may be generated by the data layer. | | `generated?` | `boolean` | `false` | Whether or not the value may be generated by the data layer. |
| `writable?` | `boolean` | false | Whether or not the value can be written to. Non-writable attributes can still be written with `Ash.Changeset.force_change_attribute/3`. | | `writable?` | `boolean` | `false` | Whether or not the value can be written to. Non-writable attributes can still be written with `Ash.Changeset.force_change_attribute/3`. |
| `private?` | `boolean` | true | The attribute is not publically writable, and should not be exposed over any public interfaces. See the [security guide](/documentation/topics/security.md) for more. | | `private?` | `boolean` | `true` | The attribute is not publically writable, and should not be exposed over any public interfaces. See the [security guide](/documentation/topics/security.md) for more. |
| `default` | `(-> any) \| mfa \| any()` | &DateTime.utc_now/0 | A value to be set on all creates, unless a value is being provided already. | | `default` | `(-> any) \| mfa \| any()` | `&DateTime.utc_now/0` | A value to be set on all creates, unless a value is being provided already. |
| `update_default` | `(-> any) \| mfa \| any()` | | A value to be set on all updates, unless a value is being provided already. | | `update_default` | `(-> any) \| mfa \| any()` | | A value to be set on all updates, unless a value is being provided already. |
| `filterable?` | `boolean \| :simple_equality` | true | Whether or not the attribute can be referenced in filters. | | `filterable?` | `boolean \| :simple_equality` | `true` | Whether or not the attribute can be referenced in filters. |
| `match_other_defaults?` | `boolean` | true | Ensures that other attributes that use the same "lazy" default (a function or an mfa), use the same default value. Has no effect unless `default` is a zero argument function. | | `match_other_defaults?` | `boolean` | `true` | Ensures that other attributes that use the same "lazy" default (a function or an mfa), use the same default value. Has no effect unless `default` is a zero argument function. |
@ -197,21 +197,21 @@ update_timestamp :updated_at
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `type` | `module` | Ash.Type.UtcDatetimeUsec | The type of the attribute. See `Ash.Type` for more. | | `type` | `module` | `Ash.Type.UtcDatetimeUsec` | The type of the attribute. See `Ash.Type` for more. |
| `constraints` | `Keyword.t` | | Constraints to provide to the type when casting the value. For more, see the [constraints topic](/documentation/topics/constraints.md). | | `constraints` | `Keyword.t` | | Constraints to provide to the type when casting the value. For more, see the [constraints topic](/documentation/topics/constraints.md). |
| `description` | `String.t` | | An optional description for the attribute. | | `description` | `String.t` | | An optional description for the attribute. |
| `sensitive?` | `boolean` | false | Whether or not the attribute value contains sensitive information, like PII. See the [Security guide](/documentation/topics/security.md) for more. | | `sensitive?` | `boolean` | `false` | Whether or not the attribute value contains sensitive information, like PII. See the [Security guide](/documentation/topics/security.md) for more. |
| `source` | `atom` | | If the field should be mapped to a different name in the data layer. Support varies by data layer. | | `source` | `atom` | | If the field should be mapped to a different name in the data layer. Support varies by data layer. |
| `always_select?` | `boolean` | false | Whether or not to ensure this attribute is always selected when reading from the database, regardless of applied select statements. | | `always_select?` | `boolean` | `false` | Whether or not to ensure this attribute is always selected when reading from the database, regardless of applied select statements. |
| `primary_key?` | `boolean` | false | Whether the attribute is the primary key. Composite primary key is also possible by using `primary_key? true` in more than one attribute. If primary_key? is true, allow_nil? must be false. | | `primary_key?` | `boolean` | `false` | Whether the attribute is the primary key. Composite primary key is also possible by using `primary_key? true` in more than one attribute. If primary_key? is true, allow_nil? must be false. |
| `allow_nil?` | `boolean` | false | Whether or not the attribute can be set to nil. If nil value is given error is raised. | | `allow_nil?` | `boolean` | `false` | Whether or not the attribute can be set to nil. If nil value is given error is raised. |
| `generated?` | `boolean` | false | Whether or not the value may be generated by the data layer. | | `generated?` | `boolean` | `false` | Whether or not the value may be generated by the data layer. |
| `writable?` | `boolean` | false | Whether or not the value can be written to. Non-writable attributes can still be written with `Ash.Changeset.force_change_attribute/3`. | | `writable?` | `boolean` | `false` | Whether or not the value can be written to. Non-writable attributes can still be written with `Ash.Changeset.force_change_attribute/3`. |
| `private?` | `boolean` | true | The attribute is not publically writable, and should not be exposed over any public interfaces. See the [security guide](/documentation/topics/security.md) for more. | | `private?` | `boolean` | `true` | The attribute is not publically writable, and should not be exposed over any public interfaces. See the [security guide](/documentation/topics/security.md) for more. |
| `default` | `(-> any) \| mfa \| any()` | &DateTime.utc_now/0 | A value to be set on all creates, unless a value is being provided already. | | `default` | `(-> any) \| mfa \| any()` | `&DateTime.utc_now/0` | A value to be set on all creates, unless a value is being provided already. |
| `update_default` | `(-> any) \| mfa \| any()` | &DateTime.utc_now/0 | A value to be set on all updates, unless a value is being provided already. | | `update_default` | `(-> any) \| mfa \| any()` | `&DateTime.utc_now/0` | A value to be set on all updates, unless a value is being provided already. |
| `filterable?` | `boolean \| :simple_equality` | true | Whether or not the attribute can be referenced in filters. | | `filterable?` | `boolean \| :simple_equality` | `true` | Whether or not the attribute can be referenced in filters. |
| `match_other_defaults?` | `boolean` | true | Ensures that other attributes that use the same "lazy" default (a function or an mfa), use the same default value. Has no effect unless `default` is a zero argument function. | | `match_other_defaults?` | `boolean` | `true` | Ensures that other attributes that use the same "lazy" default (a function or an mfa), use the same default value. Has no effect unless `default` is a zero argument function. |
@ -256,20 +256,20 @@ integer_primary_key :id
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `type` | `module` | :integer | The type of the attribute. See `Ash.Type` for more. | | `type` | `module` | `:integer` | The type of the attribute. See `Ash.Type` for more. |
| `constraints` | `Keyword.t` | | Constraints to provide to the type when casting the value. For more, see the [constraints topic](/documentation/topics/constraints.md). | | `constraints` | `Keyword.t` | | Constraints to provide to the type when casting the value. For more, see the [constraints topic](/documentation/topics/constraints.md). |
| `description` | `String.t` | | An optional description for the attribute. | | `description` | `String.t` | | An optional description for the attribute. |
| `sensitive?` | `boolean` | false | Whether or not the attribute value contains sensitive information, like PII. See the [Security guide](/documentation/topics/security.md) for more. | | `sensitive?` | `boolean` | `false` | Whether or not the attribute value contains sensitive information, like PII. See the [Security guide](/documentation/topics/security.md) for more. |
| `source` | `atom` | | If the field should be mapped to a different name in the data layer. Support varies by data layer. | | `source` | `atom` | | If the field should be mapped to a different name in the data layer. Support varies by data layer. |
| `always_select?` | `boolean` | false | Whether or not to ensure this attribute is always selected when reading from the database, regardless of applied select statements. | | `always_select?` | `boolean` | `false` | Whether or not to ensure this attribute is always selected when reading from the database, regardless of applied select statements. |
| `primary_key?` | `boolean` | true | Whether the attribute is the primary key. Composite primary key is also possible by using `primary_key? true` in more than one attribute. If primary_key? is true, allow_nil? must be false. | | `primary_key?` | `boolean` | `true` | Whether the attribute is the primary key. Composite primary key is also possible by using `primary_key? true` in more than one attribute. If primary_key? is true, allow_nil? must be false. |
| `generated?` | `boolean` | true | Whether or not the value may be generated by the data layer. | | `generated?` | `boolean` | `true` | Whether or not the value may be generated by the data layer. |
| `writable?` | `boolean` | false | Whether or not the value can be written to. Non-writable attributes can still be written with `Ash.Changeset.force_change_attribute/3`. | | `writable?` | `boolean` | `false` | Whether or not the value can be written to. Non-writable attributes can still be written with `Ash.Changeset.force_change_attribute/3`. |
| `private?` | `boolean` | false | The attribute is not publically writable, and should not be exposed over any public interfaces. See the [security guide](/documentation/topics/security.md) for more. | | `private?` | `boolean` | `false` | The attribute is not publically writable, and should not be exposed over any public interfaces. See the [security guide](/documentation/topics/security.md) for more. |
| `default` | `(-> any) \| mfa \| any()` | | A value to be set on all creates, unless a value is being provided already. | | `default` | `(-> any) \| mfa \| any()` | | A value to be set on all creates, unless a value is being provided already. |
| `update_default` | `(-> any) \| mfa \| any()` | | A value to be set on all updates, unless a value is being provided already. | | `update_default` | `(-> any) \| mfa \| any()` | | A value to be set on all updates, unless a value is being provided already. |
| `filterable?` | `boolean \| :simple_equality` | true | Whether or not the attribute can be referenced in filters. | | `filterable?` | `boolean \| :simple_equality` | `true` | Whether or not the attribute can be referenced in filters. |
| `match_other_defaults?` | `boolean` | false | Ensures that other attributes that use the same "lazy" default (a function or an mfa), use the same default value. Has no effect unless `default` is a zero argument function. | | `match_other_defaults?` | `boolean` | `false` | Ensures that other attributes that use the same "lazy" default (a function or an mfa), use the same default value. Has no effect unless `default` is a zero argument function. |
@ -313,20 +313,20 @@ uuid_primary_key :id
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `type` | `module` | :uuid | The type of the attribute. See `Ash.Type` for more. | | `type` | `module` | `:uuid` | The type of the attribute. See `Ash.Type` for more. |
| `constraints` | `Keyword.t` | | Constraints to provide to the type when casting the value. For more, see the [constraints topic](/documentation/topics/constraints.md). | | `constraints` | `Keyword.t` | | Constraints to provide to the type when casting the value. For more, see the [constraints topic](/documentation/topics/constraints.md). |
| `description` | `String.t` | | An optional description for the attribute. | | `description` | `String.t` | | An optional description for the attribute. |
| `sensitive?` | `boolean` | false | Whether or not the attribute value contains sensitive information, like PII. See the [Security guide](/documentation/topics/security.md) for more. | | `sensitive?` | `boolean` | `false` | Whether or not the attribute value contains sensitive information, like PII. See the [Security guide](/documentation/topics/security.md) for more. |
| `source` | `atom` | | If the field should be mapped to a different name in the data layer. Support varies by data layer. | | `source` | `atom` | | If the field should be mapped to a different name in the data layer. Support varies by data layer. |
| `always_select?` | `boolean` | false | Whether or not to ensure this attribute is always selected when reading from the database, regardless of applied select statements. | | `always_select?` | `boolean` | `false` | Whether or not to ensure this attribute is always selected when reading from the database, regardless of applied select statements. |
| `primary_key?` | `boolean` | true | Whether the attribute is the primary key. Composite primary key is also possible by using `primary_key? true` in more than one attribute. If primary_key? is true, allow_nil? must be false. | | `primary_key?` | `boolean` | `true` | Whether the attribute is the primary key. Composite primary key is also possible by using `primary_key? true` in more than one attribute. If primary_key? is true, allow_nil? must be false. |
| `generated?` | `boolean` | false | Whether or not the value may be generated by the data layer. | | `generated?` | `boolean` | `false` | Whether or not the value may be generated by the data layer. |
| `writable?` | `boolean` | false | Whether or not the value can be written to. Non-writable attributes can still be written with `Ash.Changeset.force_change_attribute/3`. | | `writable?` | `boolean` | `false` | Whether or not the value can be written to. Non-writable attributes can still be written with `Ash.Changeset.force_change_attribute/3`. |
| `private?` | `boolean` | false | The attribute is not publically writable, and should not be exposed over any public interfaces. See the [security guide](/documentation/topics/security.md) for more. | | `private?` | `boolean` | `false` | The attribute is not publically writable, and should not be exposed over any public interfaces. See the [security guide](/documentation/topics/security.md) for more. |
| `default` | `(-> any) \| mfa \| any()` | &Ash.UUID.generate/0 | A value to be set on all creates, unless a value is being provided already. | | `default` | `(-> any) \| mfa \| any()` | `&Ash.UUID.generate/0` | A value to be set on all creates, unless a value is being provided already. |
| `update_default` | `(-> any) \| mfa \| any()` | | A value to be set on all updates, unless a value is being provided already. | | `update_default` | `(-> any) \| mfa \| any()` | | A value to be set on all updates, unless a value is being provided already. |
| `filterable?` | `boolean \| :simple_equality` | true | Whether or not the attribute can be referenced in filters. | | `filterable?` | `boolean \| :simple_equality` | `true` | Whether or not the attribute can be referenced in filters. |
| `match_other_defaults?` | `boolean` | false | Ensures that other attributes that use the same "lazy" default (a function or an mfa), use the same default value. Has no effect unless `default` is a zero argument function. | | `match_other_defaults?` | `boolean` | `false` | Ensures that other attributes that use the same "lazy" default (a function or an mfa), use the same default value. Has no effect unless `default` is a zero argument function. |
@ -435,22 +435,22 @@ end
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `manual` | `(any, any -> any) \| module` | | A module that implements `Ash.Resource.ManualRelationship`. Also accepts a 2 argument function that takes the source records and the context. | | `manual` | `(any, any -> any) \| module` | | A module that implements `Ash.Resource.ManualRelationship`. Also accepts a 2 argument function that takes the source records and the context. |
| `no_attributes?` | `boolean` | | All existing entities are considered related, i.e this relationship is not based on any fields, and `source_attribute` and `destination_attribute` are ignored. See the See the [relationships guide](/documentation/topics/relationships.md) for more. | | `no_attributes?` | `boolean` | | All existing entities are considered related, i.e this relationship is not based on any fields, and `source_attribute` and `destination_attribute` are ignored. See the See the [relationships guide](/documentation/topics/relationships.md) for more. |
| `allow_nil?` | `boolean` | true | Marks the relationship as required. Has no effect on validations, but can inform extensions that there will always be a related entity. | | `allow_nil?` | `boolean` | `true` | Marks the relationship as required. Has no effect on validations, but can inform extensions that there will always be a related entity. |
| `from_many?` | `boolean` | false | Signal that this relationship is actually a `has_many` where the first record is given via the `sort`. This will allow data layers to properly deduplicate when necessary. | | `from_many?` | `boolean` | `false` | Signal that this relationship is actually a `has_many` where the first record is given via the `sort`. This will allow data layers to properly deduplicate when necessary. |
| `description` | `String.t` | | An optional description for the relationship | | `description` | `String.t` | | An optional description for the relationship |
| `destination_attribute` | `atom` | | The attribute on the related resource that should match the `source_attribute` configured on this resource. | | `destination_attribute` | `atom` | | The attribute on the related resource that should match the `source_attribute` configured on this resource. |
| `validate_destination_attribute?` | `boolean` | true | Whether or not to validate that the destination field exists on the destination resource | | `validate_destination_attribute?` | `boolean` | `true` | Whether or not to validate that the destination field exists on the destination resource |
| `source_attribute` | `atom` | :id | The field on this resource that should match the `destination_attribute` on the related resource. | | `source_attribute` | `atom` | `:id` | The field on this resource that should match the `destination_attribute` on the related resource. |
| `relationship_context` | ``any`` | | Context to be set on any queries or changesets generated for managing or querying this relationship. | | `relationship_context` | ``any`` | | Context to be set on any queries or changesets generated for managing or querying this relationship. |
| `private?` | `boolean` | false | Whether or not the relationship will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql See the [security guide](/documentation/topics/security.md) for more. | | `private?` | `boolean` | `false` | Whether or not the relationship will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql See the [security guide](/documentation/topics/security.md) for more. |
| `not_found_message` | `String.t` | | A message to show if there is a conflict with this relationship in the database on update or create, or when managing relationships. | | `not_found_message` | `String.t` | | A message to show if there is a conflict with this relationship in the database on update or create, or when managing relationships. |
| `writable?` | `boolean` | true | Whether or not the relationship may be managed. | | `writable?` | `boolean` | `true` | Whether or not the relationship may be managed. |
| `read_action` | `atom` | | The read action on the destination resource to use when loading data and filtering. | | `read_action` | `atom` | | The read action on the destination resource to use when loading data and filtering. |
| `api` | `atom` | | The API module to use when working with the related entity. | | `api` | `atom` | | The API module to use when working with the related entity. |
| `filter` | ``any`` | | A filter to be applied when reading the relationship. | | `filter` | ``any`` | | A filter to be applied when reading the relationship. |
| `filterable?` | `boolean` | true | If set to `false`, the relationship will not be usable in filters. | | `filterable?` | `boolean` | `true` | If set to `false`, the relationship will not be usable in filters. |
| `sort` | ``any`` | | A sort statement to be applied when loading the relationship. | | `sort` | ``any`` | | A sort statement to be applied when loading the relationship. |
| `could_be_related_at_creation?` | `boolean` | false | Whether or not related values may exist for this relationship at creation. | | `could_be_related_at_creation?` | `boolean` | `false` | Whether or not related values may exist for this relationship at creation. |
| `violation_message` | `String.t` | | A message to show if there is a conflict with this relationship in the database on destroy. | | `violation_message` | `String.t` | | A message to show if there is a conflict with this relationship in the database on destroy. |
@ -498,18 +498,18 @@ end
| `no_attributes?` | `boolean` | | All existing entities are considered related, i.e this relationship is not based on any fields, and `source_attribute` and `destination_attribute` are ignored. See the See the [relationships guide](/documentation/topics/relationships.md) for more. | | `no_attributes?` | `boolean` | | All existing entities are considered related, i.e this relationship is not based on any fields, and `source_attribute` and `destination_attribute` are ignored. See the See the [relationships guide](/documentation/topics/relationships.md) for more. |
| `description` | `String.t` | | An optional description for the relationship | | `description` | `String.t` | | An optional description for the relationship |
| `destination_attribute` | `atom` | | The attribute on the related resource that should match the `source_attribute` configured on this resource. | | `destination_attribute` | `atom` | | The attribute on the related resource that should match the `source_attribute` configured on this resource. |
| `validate_destination_attribute?` | `boolean` | true | Whether or not to validate that the destination field exists on the destination resource | | `validate_destination_attribute?` | `boolean` | `true` | Whether or not to validate that the destination field exists on the destination resource |
| `source_attribute` | `atom` | :id | The field on this resource that should match the `destination_attribute` on the related resource. | | `source_attribute` | `atom` | `:id` | The field on this resource that should match the `destination_attribute` on the related resource. |
| `relationship_context` | ``any`` | | Context to be set on any queries or changesets generated for managing or querying this relationship. | | `relationship_context` | ``any`` | | Context to be set on any queries or changesets generated for managing or querying this relationship. |
| `private?` | `boolean` | false | Whether or not the relationship will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql See the [security guide](/documentation/topics/security.md) for more. | | `private?` | `boolean` | `false` | Whether or not the relationship will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql See the [security guide](/documentation/topics/security.md) for more. |
| `not_found_message` | `String.t` | | A message to show if there is a conflict with this relationship in the database on update or create, or when managing relationships. | | `not_found_message` | `String.t` | | A message to show if there is a conflict with this relationship in the database on update or create, or when managing relationships. |
| `writable?` | `boolean` | true | Whether or not the relationship may be managed. | | `writable?` | `boolean` | `true` | Whether or not the relationship may be managed. |
| `read_action` | `atom` | | The read action on the destination resource to use when loading data and filtering. | | `read_action` | `atom` | | The read action on the destination resource to use when loading data and filtering. |
| `api` | `atom` | | The API module to use when working with the related entity. | | `api` | `atom` | | The API module to use when working with the related entity. |
| `filter` | ``any`` | | A filter to be applied when reading the relationship. | | `filter` | ``any`` | | A filter to be applied when reading the relationship. |
| `filterable?` | `boolean` | true | If set to `false`, the relationship will not be usable in filters. | | `filterable?` | `boolean` | `true` | If set to `false`, the relationship will not be usable in filters. |
| `sort` | ``any`` | | A sort statement to be applied when loading the relationship. | | `sort` | ``any`` | | A sort statement to be applied when loading the relationship. |
| `could_be_related_at_creation?` | `boolean` | false | Whether or not related values may exist for this relationship at creation. | | `could_be_related_at_creation?` | `boolean` | `false` | Whether or not related values may exist for this relationship at creation. |
| `violation_message` | `String.t` | | A message to show if there is a conflict with this relationship in the database on destroy. | | `violation_message` | `String.t` | | A message to show if there is a conflict with this relationship in the database on destroy. |
@ -567,19 +567,19 @@ belongs_to :word, Word, primary_key?: true, allow_nil?: false
| `through`* | `module` | | The resource to use as the join resource. | | `through`* | `module` | | The resource to use as the join resource. |
| `join_relationship` | `atom` | | The has_many relationship to the join resource. Defaults to <relationship_name>_join_assoc | | `join_relationship` | `atom` | | The has_many relationship to the join resource. Defaults to <relationship_name>_join_assoc |
| `description` | `String.t` | | An optional description for the relationship | | `description` | `String.t` | | An optional description for the relationship |
| `destination_attribute` | `atom` | :id | The attribute on the related resource that should match the `source_attribute` configured on this resource. | | `destination_attribute` | `atom` | `:id` | The attribute on the related resource that should match the `source_attribute` configured on this resource. |
| `validate_destination_attribute?` | `boolean` | true | Whether or not to validate that the destination field exists on the destination resource | | `validate_destination_attribute?` | `boolean` | `true` | Whether or not to validate that the destination field exists on the destination resource |
| `source_attribute` | `atom` | :id | The field on this resource that should match the `destination_attribute` on the related resource. | | `source_attribute` | `atom` | `:id` | The field on this resource that should match the `destination_attribute` on the related resource. |
| `relationship_context` | ``any`` | | Context to be set on any queries or changesets generated for managing or querying this relationship. | | `relationship_context` | ``any`` | | Context to be set on any queries or changesets generated for managing or querying this relationship. |
| `private?` | `boolean` | false | Whether or not the relationship will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql See the [security guide](/documentation/topics/security.md) for more. | | `private?` | `boolean` | `false` | Whether or not the relationship will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql See the [security guide](/documentation/topics/security.md) for more. |
| `not_found_message` | `String.t` | | A message to show if there is a conflict with this relationship in the database on update or create, or when managing relationships. | | `not_found_message` | `String.t` | | A message to show if there is a conflict with this relationship in the database on update or create, or when managing relationships. |
| `writable?` | `boolean` | true | Whether or not the relationship may be managed. | | `writable?` | `boolean` | `true` | Whether or not the relationship may be managed. |
| `read_action` | `atom` | | The read action on the destination resource to use when loading data and filtering. | | `read_action` | `atom` | | The read action on the destination resource to use when loading data and filtering. |
| `api` | `atom` | | The API module to use when working with the related entity. | | `api` | `atom` | | The API module to use when working with the related entity. |
| `filter` | ``any`` | | A filter to be applied when reading the relationship. | | `filter` | ``any`` | | A filter to be applied when reading the relationship. |
| `filterable?` | `boolean` | true | If set to `false`, the relationship will not be usable in filters. | | `filterable?` | `boolean` | `true` | If set to `false`, the relationship will not be usable in filters. |
| `sort` | ``any`` | | A sort statement to be applied when loading the relationship. | | `sort` | ``any`` | | A sort statement to be applied when loading the relationship. |
| `could_be_related_at_creation?` | `boolean` | false | Whether or not related values may exist for this relationship at creation. | | `could_be_related_at_creation?` | `boolean` | `false` | Whether or not related values may exist for this relationship at creation. |
| `violation_message` | `String.t` | | A message to show if there is a conflict with this relationship in the database on destroy. | | `violation_message` | `String.t` | | A message to show if there is a conflict with this relationship in the database on destroy. |
@ -625,23 +625,23 @@ end
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `primary_key?` | `boolean` | false | Whether the generated attribute is, or is part of, the primary key of a resource. | | `primary_key?` | `boolean` | `false` | Whether the generated attribute is, or is part of, the primary key of a resource. |
| `allow_nil?` | `boolean` | true | Whether this relationship must always be present, e.g: must be included on creation, and never removed (it may be modified). The generated attribute will not allow nil values. | | `allow_nil?` | `boolean` | `true` | Whether this relationship must always be present, e.g: must be included on creation, and never removed (it may be modified). The generated attribute will not allow nil values. |
| `attribute_writable?` | `boolean` | false | Whether the generated attribute will be marked as public & writable. | | `attribute_writable?` | `boolean` | `false` | Whether the generated attribute will be marked as public & writable. |
| `define_attribute?` | `boolean` | true | If set to `false` an attribute is not created on the resource for this relationship, and one must be manually added in `attributes`, invalidating many other options. | | `define_attribute?` | `boolean` | `true` | If set to `false` an attribute is not created on the resource for this relationship, and one must be manually added in `attributes`, invalidating many other options. |
| `attribute_type` | ``any`` | :uuid | The type of the generated created attribute. See `Ash.Type` for more. | | `attribute_type` | ``any`` | `:uuid` | The type of the generated created attribute. See `Ash.Type` for more. |
| `description` | `String.t` | | An optional description for the relationship | | `description` | `String.t` | | An optional description for the relationship |
| `destination_attribute` | `atom` | :id | The attribute on the related resource that should match the `source_attribute` configured on this resource. | | `destination_attribute` | `atom` | `:id` | The attribute on the related resource that should match the `source_attribute` configured on this resource. |
| `validate_destination_attribute?` | `boolean` | true | Whether or not to validate that the destination field exists on the destination resource | | `validate_destination_attribute?` | `boolean` | `true` | Whether or not to validate that the destination field exists on the destination resource |
| `source_attribute` | `atom` | | The field on this resource that should match the `destination_attribute` on the related resource. - Defaults to <name>_id | | `source_attribute` | `atom` | | The field on this resource that should match the `destination_attribute` on the related resource. - Defaults to <name>_id |
| `relationship_context` | ``any`` | | Context to be set on any queries or changesets generated for managing or querying this relationship. | | `relationship_context` | ``any`` | | Context to be set on any queries or changesets generated for managing or querying this relationship. |
| `private?` | `boolean` | false | Whether or not the relationship will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql See the [security guide](/documentation/topics/security.md) for more. | | `private?` | `boolean` | `false` | Whether or not the relationship will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql See the [security guide](/documentation/topics/security.md) for more. |
| `not_found_message` | `String.t` | | A message to show if there is a conflict with this relationship in the database on update or create, or when managing relationships. | | `not_found_message` | `String.t` | | A message to show if there is a conflict with this relationship in the database on update or create, or when managing relationships. |
| `writable?` | `boolean` | true | Whether or not the relationship may be managed. | | `writable?` | `boolean` | `true` | Whether or not the relationship may be managed. |
| `read_action` | `atom` | | The read action on the destination resource to use when loading data and filtering. | | `read_action` | `atom` | | The read action on the destination resource to use when loading data and filtering. |
| `api` | `atom` | | The API module to use when working with the related entity. | | `api` | `atom` | | The API module to use when working with the related entity. |
| `filter` | ``any`` | | A filter to be applied when reading the relationship. | | `filter` | ``any`` | | A filter to be applied when reading the relationship. |
| `filterable?` | `boolean` | true | If set to `false`, the relationship will not be usable in filters. | | `filterable?` | `boolean` | `true` | If set to `false`, the relationship will not be usable in filters. |
| `sort` | ``any`` | | A sort statement to be applied when loading the relationship. | | `sort` | ``any`` | | A sort statement to be applied when loading the relationship. |
| `violation_message` | `String.t` | | A message to show if there is a conflict with this relationship in the database on destroy. | | `violation_message` | `String.t` | | A message to show if there is a conflict with this relationship in the database on destroy. |
@ -773,9 +773,9 @@ end
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `constraints` | `Keyword.t` | | Constraints for the return type. See the [constriants topic](/documentation/topics/constraints.md) for more. | | `constraints` | `Keyword.t` | | Constraints for the return type. See the [constriants topic](/documentation/topics/constraints.md) for more. |
| `allow_nil?` | `boolean` | false | Wether or not the action can return nil. Unlike attributes & arguments, this defaults to `false`. | | `allow_nil?` | `boolean` | `false` | Wether or not the action can return nil. Unlike attributes & arguments, this defaults to `false`. |
| `run` | `(any, any -> any) \| module` | | | | `run` | `(any, any -> any) \| module` | | |
| `primary?` | `boolean` | false | Whether or not this action should be used when no action is specified by the caller. | | `primary?` | `boolean` | `false` | Whether or not this action should be used when no action is specified by the caller. |
| `description` | `String.t` | | An optional description for the action | | `description` | `String.t` | | An optional description for the action |
| `transaction?` | `boolean` | | Whether or not the action should be run in transactions. Reads default to false, while create/update/destroy actions default to `true`. | | `transaction?` | `boolean` | | Whether or not the action should be run in transactions. Reads default to false, while create/update/destroy actions default to `true`. |
| `touches_resources` | `list(atom)` | | A list of resources that the action may touch, used when building transactions. | | `touches_resources` | `list(atom)` | | A list of resources that the action may touch, used when building transactions. |
@ -808,10 +808,10 @@ argument :password_confirmation, :string
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `description` | `String.t` | | An optional description for the argument. | | `description` | `String.t` | | An optional description for the argument. |
| `constraints` | `Keyword.t` | [] | Constraints to provide to the type when casting the value. For more information, see [the constraints topic](/documentation/topics/constraints.md). | | `constraints` | `Keyword.t` | `[]` | Constraints to provide to the type when casting the value. For more information, see [the constraints topic](/documentation/topics/constraints.md). |
| `allow_nil?` | `boolean` | true | Whether or not the argument value may be nil (or may be not provided). If nil value is given error is raised. | | `allow_nil?` | `boolean` | `true` | Whether or not the argument value may be nil (or may be not provided). If nil value is given error is raised. |
| `private?` | `boolean` | false | Whether or not the argument should be suppliable by the client. | | `private?` | `boolean` | `false` | Whether or not the argument should be suppliable by the client. |
| `sensitive?` | `boolean` | false | Whether or not the argument value contains sensitive information, like PII. See the [security guide](/documentation/topics/security.md) for more. | | `sensitive?` | `boolean` | `false` | Whether or not the argument value contains sensitive information, like PII. See the [security guide](/documentation/topics/security.md) for more. |
| `default` | ``any`` | | The default value for the argument to take. It can be a zero argument function e.g `&MyMod.my_fun/0` or a value | | `default` | ``any`` | | The default value for the argument to take. It can be a zero argument function e.g `&MyMod.my_fun/0` or a value |
@ -864,16 +864,16 @@ end
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `allow_nil_input` | `list(atom)` | | A list of attributes that would normally be required, but should not be for this action. They will still be validated just before the record is created. | | `allow_nil_input` | `list(atom)` | | A list of attributes that would normally be required, but should not be for this action. They will still be validated just before the record is created. |
| `manual` | `(any, any -> any) \| module` | | Override the creation behavior. Accepts a module or module and opts, or a function that takes the changeset and context. See the [manual actions guide](/documentation/topics/manual-actions.md) for more. | | `manual` | `(any, any -> any) \| module` | | Override the creation behavior. Accepts a module or module and opts, or a function that takes the changeset and context. See the [manual actions guide](/documentation/topics/manual-actions.md) for more. |
| `upsert?` | `boolean` | false | Forces all uses of this action to be treated as an upsert. | | `upsert?` | `boolean` | `false` | Forces all uses of this action to be treated as an upsert. |
| `upsert_identity` | `atom` | | The identity to use for the upsert. Cannot be overriden by the caller. Ignored if `upsert?` is not set to `true`. | | `upsert_identity` | `atom` | | The identity to use for the upsert. Cannot be overriden by the caller. Ignored if `upsert?` is not set to `true`. |
| `upsert_fields` | `list(atom)` | | The fields to overwrite in the case of an upsert. If not provided, all fields except for fields set by defaults will be overwritten. | | `upsert_fields` | `list(atom)` | | The fields to overwrite in the case of an upsert. If not provided, all fields except for fields set by defaults will be overwritten. |
| `primary?` | `boolean` | false | Whether or not this action should be used when no action is specified by the caller. | | `primary?` | `boolean` | `false` | Whether or not this action should be used when no action is specified by the caller. |
| `description` | `String.t` | | An optional description for the action | | `description` | `String.t` | | An optional description for the action |
| `transaction?` | `boolean` | | Whether or not the action should be run in transactions. Reads default to false, while create/update/destroy actions default to `true`. | | `transaction?` | `boolean` | | Whether or not the action should be run in transactions. Reads default to false, while create/update/destroy actions default to `true`. |
| `touches_resources` | `list(atom)` | | A list of resources that the action may touch, used when building transactions. | | `touches_resources` | `list(atom)` | | A list of resources that the action may touch, used when building transactions. |
| `accept` | `:all \| list(atom)` | | The list of attributes to accept. Defaults to all attributes on the resource | | `accept` | `:all \| list(atom)` | | The list of attributes to accept. Defaults to all attributes on the resource |
| `delay_global_validations?` | `boolean` | false | If true, global validations will be done in a `before_action` hook, regardless of their configuration on the resource. | | `delay_global_validations?` | `boolean` | `false` | If true, global validations will be done in a `before_action` hook, regardless of their configuration on the resource. |
| `skip_global_validations?` | `boolean` | false | If true, global validations will be skipped. Useful for manual actions. | | `skip_global_validations?` | `boolean` | `false` | If true, global validations will be skipped. Useful for manual actions. |
| `reject` | `:all \| list(atom)` | | A list of attributes not to accept. If this is specified along with `accept`, these are removed from the `accept` list. | | `reject` | `:all \| list(atom)` | | A list of attributes not to accept. If this is specified along with `accept`, these are removed from the `accept` list. |
| `require_attributes` | `list(atom)` | | A list of attributes that would normally `allow_nil?`, to require for this action. No need to include attributes that already do not allow nil? | | `require_attributes` | `list(atom)` | | A list of attributes that would normally `allow_nil?`, to require for this action. No need to include attributes that already do not allow nil? |
| `error_handler` | `mfa` | | Sets the error handler on the changeset. See `Ash.Changeset.handle_errors/2` for more | | `error_handler` | `mfa` | | Sets the error handler on the changeset. See `Ash.Changeset.handle_errors/2` for more |
@ -911,9 +911,9 @@ change {MyCustomChange, :foo}
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `only_when_valid?` | `boolean` | false | If the change should only be run on valid changes. By default, all changes are run unless stated otherwise here. | | `only_when_valid?` | `boolean` | `false` | If the change should only be run on valid changes. By default, all changes are run unless stated otherwise here. |
| `description` | `String.t` | | An optional description for the change | | `description` | `String.t` | | An optional description for the change |
| `where` | `list((any -> any) \| module)` | [] | Validations that should pass in order for this validation to apply. These validations failing will result in this validation being ignored. | | `where` | `list((any -> any) \| module)` | `[]` | Validations that should pass in order for this validation to apply. These validations failing will result in this validation being ignored. |
@ -950,11 +950,11 @@ validate changing(:email)
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `where` | `list((any -> any) \| module) \| (any -> any) \| module` | [] | Validations that should pass in order for this validation to apply. Any of these validations failing will result in this validation being ignored. | | `where` | `list((any -> any) \| module) \| (any -> any) \| module` | `[]` | Validations that should pass in order for this validation to apply. Any of these validations failing will result in this validation being ignored. |
| `only_when_valid?` | `boolean` | false | If the validation should only run on valid changes. Useful for expensive validations or validations that depend on valid data. | | `only_when_valid?` | `boolean` | `false` | If the validation should only run on valid changes. Useful for expensive validations or validations that depend on valid data. |
| `message` | `String.t` | | If provided, overrides any message set by the validation error | | `message` | `String.t` | | If provided, overrides any message set by the validation error |
| `description` | `String.t` | | An optional description for the validation | | `description` | `String.t` | | An optional description for the validation |
| `before_action?` | `boolean` | false | If set to `true`, the validation will be run in a before_action hook | | `before_action?` | `boolean` | `false` | If set to `true`, the validation will be run in a before_action hook |
@ -991,10 +991,10 @@ argument :password_confirmation, :string
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `description` | `String.t` | | An optional description for the argument. | | `description` | `String.t` | | An optional description for the argument. |
| `constraints` | `Keyword.t` | [] | Constraints to provide to the type when casting the value. For more information, see [the constraints topic](/documentation/topics/constraints.md). | | `constraints` | `Keyword.t` | `[]` | Constraints to provide to the type when casting the value. For more information, see [the constraints topic](/documentation/topics/constraints.md). |
| `allow_nil?` | `boolean` | true | Whether or not the argument value may be nil (or may be not provided). If nil value is given error is raised. | | `allow_nil?` | `boolean` | `true` | Whether or not the argument value may be nil (or may be not provided). If nil value is given error is raised. |
| `private?` | `boolean` | false | Whether or not the argument should be suppliable by the client. | | `private?` | `boolean` | `false` | Whether or not the argument should be suppliable by the client. |
| `sensitive?` | `boolean` | false | Whether or not the argument value contains sensitive information, like PII. See the [security guide](/documentation/topics/security.md) for more. | | `sensitive?` | `boolean` | `false` | Whether or not the argument value contains sensitive information, like PII. See the [security guide](/documentation/topics/security.md) for more. |
| `default` | ``any`` | | The default value for the argument to take. It can be a zero argument function e.g `&MyMod.my_fun/0` or a value | | `default` | ``any`` | | The default value for the argument to take. It can be a zero argument function e.g `&MyMod.my_fun/0` or a value |
@ -1038,9 +1038,9 @@ metadata :operation_id, :string, allow_nil?: false
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `constraints` | `Keyword.t` | [] | Type constraints on the metadata | | `constraints` | `Keyword.t` | `[]` | Type constraints on the metadata |
| `description` | `String.t` | | An optional description for the metadata. | | `description` | `String.t` | | An optional description for the metadata. |
| `allow_nil?` | `boolean` | true | Whether or not the metadata may return `nil` | | `allow_nil?` | `boolean` | `true` | Whether or not the metadata may return `nil` |
| `default` | ``any`` | | The default value for the metadata to take. It can be a zero argument function e.g `&MyMod.my_fun/0` or a value | | `default` | ``any`` | | The default value for the metadata to take. It can be a zero argument function e.g `&MyMod.my_fun/0` or a value |
@ -1093,10 +1093,10 @@ end
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `filter` | ``any`` | | A filter template that will be applied whenever the action is used. See `Ash.Filter` for more on templates | | `filter` | ``any`` | | A filter template that will be applied whenever the action is used. See `Ash.Filter` for more on templates |
| `manual` | `(any, any, any -> any) \| module` | | Delegates running of the query to the provided module. Accepts a module or module and opts, or a function that takes the changeset and context. See the [manual actions guide](/documentation/topics/manual-actions.md) for more. | | `manual` | `(any, any, any -> any) \| module` | | Delegates running of the query to the provided module. Accepts a module or module and opts, or a function that takes the changeset and context. See the [manual actions guide](/documentation/topics/manual-actions.md) for more. |
| `get?` | `boolean` | false | Expresses that this action innately only returns a single result. Used by extensions to validate and/or modify behavior. Causes code interfaces to return a single value instead of a list. See the [code interface guide](/documentation/topics/code-interface.md) for more. | | `get?` | `boolean` | `false` | Expresses that this action innately only returns a single result. Used by extensions to validate and/or modify behavior. Causes code interfaces to return a single value instead of a list. See the [code interface guide](/documentation/topics/code-interface.md) for more. |
| `modify_query` | `mfa \| (any, any -> any)` | | Allows direct manipulation of the data layer query via an MFA. The ash query and the data layer query will be provided as additional arguments. The result must be `{:ok, new_data_layer_query} \| {:error, error}`. | | `modify_query` | `mfa \| (any, any -> any)` | | Allows direct manipulation of the data layer query via an MFA. The ash query and the data layer query will be provided as additional arguments. The result must be `{:ok, new_data_layer_query} \| {:error, error}`. |
| `get_by` | `list(atom) \| atom` | | A helper to automatically generate a "get by X" action. Sets `get?` to true, add args for each of the specified fields, and adds a filter for each of the arguments. | | `get_by` | `list(atom) \| atom` | | A helper to automatically generate a "get by X" action. Sets `get?` to true, add args for each of the specified fields, and adds a filter for each of the arguments. |
| `primary?` | `boolean` | false | Whether or not this action should be used when no action is specified by the caller. | | `primary?` | `boolean` | `false` | Whether or not this action should be used when no action is specified by the caller. |
| `description` | `String.t` | | An optional description for the action | | `description` | `String.t` | | An optional description for the action |
| `transaction?` | `boolean` | | Whether or not the action should be run in transactions. Reads default to false, while create/update/destroy actions default to `true`. | | `transaction?` | `boolean` | | Whether or not the action should be run in transactions. Reads default to false, while create/update/destroy actions default to `true`. |
| `touches_resources` | `list(atom)` | | A list of resources that the action may touch, used when building transactions. | | `touches_resources` | `list(atom)` | | A list of resources that the action may touch, used when building transactions. |
@ -1129,10 +1129,10 @@ argument :password_confirmation, :string
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `description` | `String.t` | | An optional description for the argument. | | `description` | `String.t` | | An optional description for the argument. |
| `constraints` | `Keyword.t` | [] | Constraints to provide to the type when casting the value. For more information, see [the constraints topic](/documentation/topics/constraints.md). | | `constraints` | `Keyword.t` | `[]` | Constraints to provide to the type when casting the value. For more information, see [the constraints topic](/documentation/topics/constraints.md). |
| `allow_nil?` | `boolean` | true | Whether or not the argument value may be nil (or may be not provided). If nil value is given error is raised. | | `allow_nil?` | `boolean` | `true` | Whether or not the argument value may be nil (or may be not provided). If nil value is given error is raised. |
| `private?` | `boolean` | false | Whether or not the argument should be suppliable by the client. | | `private?` | `boolean` | `false` | Whether or not the argument should be suppliable by the client. |
| `sensitive?` | `boolean` | false | Whether or not the argument value contains sensitive information, like PII. See the [security guide](/documentation/topics/security.md) for more. | | `sensitive?` | `boolean` | `false` | Whether or not the argument value contains sensitive information, like PII. See the [security guide](/documentation/topics/security.md) for more. |
| `default` | ``any`` | | The default value for the argument to take. It can be a zero argument function e.g `&MyMod.my_fun/0` or a value | | `default` | ``any`` | | The default value for the argument to take. It can be a zero argument function e.g `&MyMod.my_fun/0` or a value |
@ -1190,12 +1190,12 @@ Adds pagination options to a resource
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `keyset?` | `boolean` | false | Whether or not keyset based pagination is supported | | `keyset?` | `boolean` | `false` | Whether or not keyset based pagination is supported |
| `offset?` | `boolean` | false | Whether or not offset based pagination is supported | | `offset?` | `boolean` | `false` | Whether or not offset based pagination is supported |
| `default_limit` | `pos_integer` | | The default page size to apply, if one is not supplied | | `default_limit` | `pos_integer` | | The default page size to apply, if one is not supplied |
| `countable` | `true \| false \| :by_default` | false | Whether not a returned page will have a full count of all records. Use `:by_default` to do it automatically. | | `countable` | `true \| false \| :by_default` | `false` | Whether not a returned page will have a full count of all records. Use `:by_default` to do it automatically. |
| `max_page_size` | `pos_integer` | 250 | The maximum amount of records that can be requested in a single page | | `max_page_size` | `pos_integer` | `250` | The maximum amount of records that can be requested in a single page |
| `required?` | `boolean` | true | Whether or not pagination can be disabled. Only relevant if some pagination configuration is supplied. | | `required?` | `boolean` | `true` | Whether or not pagination can be disabled. Only relevant if some pagination configuration is supplied. |
@ -1238,9 +1238,9 @@ metadata :operation_id, :string, allow_nil?: false
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `constraints` | `Keyword.t` | [] | Type constraints on the metadata | | `constraints` | `Keyword.t` | `[]` | Type constraints on the metadata |
| `description` | `String.t` | | An optional description for the metadata. | | `description` | `String.t` | | An optional description for the metadata. |
| `allow_nil?` | `boolean` | true | Whether or not the metadata may return `nil` | | `allow_nil?` | `boolean` | `true` | Whether or not the metadata may return `nil` |
| `default` | ``any`` | | The default value for the metadata to take. It can be a zero argument function e.g `&MyMod.my_fun/0` or a value | | `default` | ``any`` | | The default value for the metadata to take. It can be a zero argument function e.g `&MyMod.my_fun/0` or a value |
@ -1289,13 +1289,13 @@ update :flag_for_review, primary?: true
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `manual` | `(any, any -> any) \| module` | | Override the update behavior. Accepts a module or module and opts, or a function that takes the changeset and context. See the [manual actions guide](/documentation/topics/manual-actions.md) for more. | | `manual` | `(any, any -> any) \| module` | | Override the update behavior. Accepts a module or module and opts, or a function that takes the changeset and context. See the [manual actions guide](/documentation/topics/manual-actions.md) for more. |
| `primary?` | `boolean` | false | Whether or not this action should be used when no action is specified by the caller. | | `primary?` | `boolean` | `false` | Whether or not this action should be used when no action is specified by the caller. |
| `description` | `String.t` | | An optional description for the action | | `description` | `String.t` | | An optional description for the action |
| `transaction?` | `boolean` | | Whether or not the action should be run in transactions. Reads default to false, while create/update/destroy actions default to `true`. | | `transaction?` | `boolean` | | Whether or not the action should be run in transactions. Reads default to false, while create/update/destroy actions default to `true`. |
| `touches_resources` | `list(atom)` | | A list of resources that the action may touch, used when building transactions. | | `touches_resources` | `list(atom)` | | A list of resources that the action may touch, used when building transactions. |
| `accept` | `:all \| list(atom)` | | The list of attributes to accept. Defaults to all attributes on the resource | | `accept` | `:all \| list(atom)` | | The list of attributes to accept. Defaults to all attributes on the resource |
| `delay_global_validations?` | `boolean` | false | If true, global validations will be done in a `before_action` hook, regardless of their configuration on the resource. | | `delay_global_validations?` | `boolean` | `false` | If true, global validations will be done in a `before_action` hook, regardless of their configuration on the resource. |
| `skip_global_validations?` | `boolean` | false | If true, global validations will be skipped. Useful for manual actions. | | `skip_global_validations?` | `boolean` | `false` | If true, global validations will be skipped. Useful for manual actions. |
| `reject` | `:all \| list(atom)` | | A list of attributes not to accept. If this is specified along with `accept`, these are removed from the `accept` list. | | `reject` | `:all \| list(atom)` | | A list of attributes not to accept. If this is specified along with `accept`, these are removed from the `accept` list. |
| `require_attributes` | `list(atom)` | | A list of attributes that would normally `allow_nil?`, to require for this action. No need to include attributes that already do not allow nil? | | `require_attributes` | `list(atom)` | | A list of attributes that would normally `allow_nil?`, to require for this action. No need to include attributes that already do not allow nil? |
| `error_handler` | `mfa` | | Sets the error handler on the changeset. See `Ash.Changeset.handle_errors/2` for more | | `error_handler` | `mfa` | | Sets the error handler on the changeset. See `Ash.Changeset.handle_errors/2` for more |
@ -1333,9 +1333,9 @@ change {MyCustomChange, :foo}
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `only_when_valid?` | `boolean` | false | If the change should only be run on valid changes. By default, all changes are run unless stated otherwise here. | | `only_when_valid?` | `boolean` | `false` | If the change should only be run on valid changes. By default, all changes are run unless stated otherwise here. |
| `description` | `String.t` | | An optional description for the change | | `description` | `String.t` | | An optional description for the change |
| `where` | `list((any -> any) \| module)` | [] | Validations that should pass in order for this validation to apply. These validations failing will result in this validation being ignored. | | `where` | `list((any -> any) \| module)` | `[]` | Validations that should pass in order for this validation to apply. These validations failing will result in this validation being ignored. |
@ -1372,11 +1372,11 @@ validate changing(:email)
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `where` | `list((any -> any) \| module) \| (any -> any) \| module` | [] | Validations that should pass in order for this validation to apply. Any of these validations failing will result in this validation being ignored. | | `where` | `list((any -> any) \| module) \| (any -> any) \| module` | `[]` | Validations that should pass in order for this validation to apply. Any of these validations failing will result in this validation being ignored. |
| `only_when_valid?` | `boolean` | false | If the validation should only run on valid changes. Useful for expensive validations or validations that depend on valid data. | | `only_when_valid?` | `boolean` | `false` | If the validation should only run on valid changes. Useful for expensive validations or validations that depend on valid data. |
| `message` | `String.t` | | If provided, overrides any message set by the validation error | | `message` | `String.t` | | If provided, overrides any message set by the validation error |
| `description` | `String.t` | | An optional description for the validation | | `description` | `String.t` | | An optional description for the validation |
| `before_action?` | `boolean` | false | If set to `true`, the validation will be run in a before_action hook | | `before_action?` | `boolean` | `false` | If set to `true`, the validation will be run in a before_action hook |
@ -1419,9 +1419,9 @@ metadata :operation_id, :string, allow_nil?: false
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `constraints` | `Keyword.t` | [] | Type constraints on the metadata | | `constraints` | `Keyword.t` | `[]` | Type constraints on the metadata |
| `description` | `String.t` | | An optional description for the metadata. | | `description` | `String.t` | | An optional description for the metadata. |
| `allow_nil?` | `boolean` | true | Whether or not the metadata may return `nil` | | `allow_nil?` | `boolean` | `true` | Whether or not the metadata may return `nil` |
| `default` | ``any`` | | The default value for the metadata to take. It can be a zero argument function e.g `&MyMod.my_fun/0` or a value | | `default` | ``any`` | | The default value for the metadata to take. It can be a zero argument function e.g `&MyMod.my_fun/0` or a value |
@ -1459,10 +1459,10 @@ argument :password_confirmation, :string
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `description` | `String.t` | | An optional description for the argument. | | `description` | `String.t` | | An optional description for the argument. |
| `constraints` | `Keyword.t` | [] | Constraints to provide to the type when casting the value. For more information, see [the constraints topic](/documentation/topics/constraints.md). | | `constraints` | `Keyword.t` | `[]` | Constraints to provide to the type when casting the value. For more information, see [the constraints topic](/documentation/topics/constraints.md). |
| `allow_nil?` | `boolean` | true | Whether or not the argument value may be nil (or may be not provided). If nil value is given error is raised. | | `allow_nil?` | `boolean` | `true` | Whether or not the argument value may be nil (or may be not provided). If nil value is given error is raised. |
| `private?` | `boolean` | false | Whether or not the argument should be suppliable by the client. | | `private?` | `boolean` | `false` | Whether or not the argument should be suppliable by the client. |
| `sensitive?` | `boolean` | false | Whether or not the argument value contains sensitive information, like PII. See the [security guide](/documentation/topics/security.md) for more. | | `sensitive?` | `boolean` | `false` | Whether or not the argument value contains sensitive information, like PII. See the [security guide](/documentation/topics/security.md) for more. |
| `default` | ``any`` | | The default value for the argument to take. It can be a zero argument function e.g `&MyMod.my_fun/0` or a value | | `default` | ``any`` | | The default value for the argument to take. It can be a zero argument function e.g `&MyMod.my_fun/0` or a value |
@ -1513,15 +1513,15 @@ end
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `soft?` | `atom` | false | If specified, the destroy action behaves as an update internally | | `soft?` | `atom` | `false` | If specified, the destroy action behaves as an update internally |
| `manual` | `(any, any -> any) \| module` | | Override the update behavior. Accepts a module or module and opts, or a function that takes the changeset and context. See the [manual actions guide](/documentation/topics/manual-actions.md) for more. | | `manual` | `(any, any -> any) \| module` | | Override the update behavior. Accepts a module or module and opts, or a function that takes the changeset and context. See the [manual actions guide](/documentation/topics/manual-actions.md) for more. |
| `primary?` | `boolean` | false | Whether or not this action should be used when no action is specified by the caller. | | `primary?` | `boolean` | `false` | Whether or not this action should be used when no action is specified by the caller. |
| `description` | `String.t` | | An optional description for the action | | `description` | `String.t` | | An optional description for the action |
| `transaction?` | `boolean` | | Whether or not the action should be run in transactions. Reads default to false, while create/update/destroy actions default to `true`. | | `transaction?` | `boolean` | | Whether or not the action should be run in transactions. Reads default to false, while create/update/destroy actions default to `true`. |
| `touches_resources` | `list(atom)` | | A list of resources that the action may touch, used when building transactions. | | `touches_resources` | `list(atom)` | | A list of resources that the action may touch, used when building transactions. |
| `accept` | `:all \| list(atom)` | | The list of attributes to accept. Defaults to all attributes on the resource | | `accept` | `:all \| list(atom)` | | The list of attributes to accept. Defaults to all attributes on the resource |
| `delay_global_validations?` | `boolean` | false | If true, global validations will be done in a `before_action` hook, regardless of their configuration on the resource. | | `delay_global_validations?` | `boolean` | `false` | If true, global validations will be done in a `before_action` hook, regardless of their configuration on the resource. |
| `skip_global_validations?` | `boolean` | false | If true, global validations will be skipped. Useful for manual actions. | | `skip_global_validations?` | `boolean` | `false` | If true, global validations will be skipped. Useful for manual actions. |
| `reject` | `:all \| list(atom)` | | A list of attributes not to accept. If this is specified along with `accept`, these are removed from the `accept` list. | | `reject` | `:all \| list(atom)` | | A list of attributes not to accept. If this is specified along with `accept`, these are removed from the `accept` list. |
| `require_attributes` | `list(atom)` | | A list of attributes that would normally `allow_nil?`, to require for this action. No need to include attributes that already do not allow nil? | | `require_attributes` | `list(atom)` | | A list of attributes that would normally `allow_nil?`, to require for this action. No need to include attributes that already do not allow nil? |
| `error_handler` | `mfa` | | Sets the error handler on the changeset. See `Ash.Changeset.handle_errors/2` for more | | `error_handler` | `mfa` | | Sets the error handler on the changeset. See `Ash.Changeset.handle_errors/2` for more |
@ -1559,9 +1559,9 @@ change {MyCustomChange, :foo}
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `only_when_valid?` | `boolean` | false | If the change should only be run on valid changes. By default, all changes are run unless stated otherwise here. | | `only_when_valid?` | `boolean` | `false` | If the change should only be run on valid changes. By default, all changes are run unless stated otherwise here. |
| `description` | `String.t` | | An optional description for the change | | `description` | `String.t` | | An optional description for the change |
| `where` | `list((any -> any) \| module)` | [] | Validations that should pass in order for this validation to apply. These validations failing will result in this validation being ignored. | | `where` | `list((any -> any) \| module)` | `[]` | Validations that should pass in order for this validation to apply. These validations failing will result in this validation being ignored. |
@ -1598,11 +1598,11 @@ validate changing(:email)
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `where` | `list((any -> any) \| module) \| (any -> any) \| module` | [] | Validations that should pass in order for this validation to apply. Any of these validations failing will result in this validation being ignored. | | `where` | `list((any -> any) \| module) \| (any -> any) \| module` | `[]` | Validations that should pass in order for this validation to apply. Any of these validations failing will result in this validation being ignored. |
| `only_when_valid?` | `boolean` | false | If the validation should only run on valid changes. Useful for expensive validations or validations that depend on valid data. | | `only_when_valid?` | `boolean` | `false` | If the validation should only run on valid changes. Useful for expensive validations or validations that depend on valid data. |
| `message` | `String.t` | | If provided, overrides any message set by the validation error | | `message` | `String.t` | | If provided, overrides any message set by the validation error |
| `description` | `String.t` | | An optional description for the validation | | `description` | `String.t` | | An optional description for the validation |
| `before_action?` | `boolean` | false | If set to `true`, the validation will be run in a before_action hook | | `before_action?` | `boolean` | `false` | If set to `true`, the validation will be run in a before_action hook |
@ -1645,9 +1645,9 @@ metadata :operation_id, :string, allow_nil?: false
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `constraints` | `Keyword.t` | [] | Type constraints on the metadata | | `constraints` | `Keyword.t` | `[]` | Type constraints on the metadata |
| `description` | `String.t` | | An optional description for the metadata. | | `description` | `String.t` | | An optional description for the metadata. |
| `allow_nil?` | `boolean` | true | Whether or not the metadata may return `nil` | | `allow_nil?` | `boolean` | `true` | Whether or not the metadata may return `nil` |
| `default` | ``any`` | | The default value for the metadata to take. It can be a zero argument function e.g `&MyMod.my_fun/0` or a value | | `default` | ``any`` | | The default value for the metadata to take. It can be a zero argument function e.g `&MyMod.my_fun/0` or a value |
@ -1685,10 +1685,10 @@ argument :password_confirmation, :string
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `description` | `String.t` | | An optional description for the argument. | | `description` | `String.t` | | An optional description for the argument. |
| `constraints` | `Keyword.t` | [] | Constraints to provide to the type when casting the value. For more information, see [the constraints topic](/documentation/topics/constraints.md). | | `constraints` | `Keyword.t` | `[]` | Constraints to provide to the type when casting the value. For more information, see [the constraints topic](/documentation/topics/constraints.md). |
| `allow_nil?` | `boolean` | true | Whether or not the argument value may be nil (or may be not provided). If nil value is given error is raised. | | `allow_nil?` | `boolean` | `true` | Whether or not the argument value may be nil (or may be not provided). If nil value is given error is raised. |
| `private?` | `boolean` | false | Whether or not the argument should be suppliable by the client. | | `private?` | `boolean` | `false` | Whether or not the argument should be suppliable by the client. |
| `sensitive?` | `boolean` | false | Whether or not the argument value contains sensitive information, like PII. See the [security guide](/documentation/topics/security.md) for more. | | `sensitive?` | `boolean` | `false` | Whether or not the argument value contains sensitive information, like PII. See the [security guide](/documentation/topics/security.md) for more. |
| `default` | ``any`` | | The default value for the argument to take. It can be a zero argument function e.g `&MyMod.my_fun/0` or a value | | `default` | ``any`` | | The default value for the argument to take. It can be a zero argument function e.g `&MyMod.my_fun/0` or a value |
@ -1734,7 +1734,7 @@ end
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `define_for` | `module` | false | Defines the code interface on the resource module directly, using the provided Api. | | `define_for` | `module` | `false` | Defines the code interface on the resource module directly, using the provided Api. |
@ -1765,7 +1765,7 @@ define :get_user_by_id, action: :get_by_id, args: [:id], get?: true
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `action` | `atom` | | The name of the action that will be called. Defaults to the same name as the function. | | `action` | `atom` | | The name of the action that will be called. Defaults to the same name as the function. |
| `args` | `list(atom \| {:optional, atom})` | | Map specific arguments to named inputs. Can provide any argument/attributes that the action allows. | | `args` | `list(atom \| {:optional, atom})` | | Map specific arguments to named inputs. Can provide any argument/attributes that the action allows. |
| `not_found_error?` | `boolean` | true | If the action or interface is configured with `get?: true`, this determines whether or not an error is raised or `nil` is returned. | | `not_found_error?` | `boolean` | `true` | If the action or interface is configured with `get?: true`, this determines whether or not an error is raised or `nil` is returned. |
| `get?` | `boolean` | | Expects to only receive a single result from a read action, and returns a single result instead of a list. Ignored for other action types. | | `get?` | `boolean` | | Expects to only receive a single result from a read action, and returns a single result instead of a list. Ignored for other action types. |
| `get_by` | `list(atom) \| atom` | | Takes a list of fields and adds those fields as arguments, which will then be used to filter. Sets `get?` to true automatically. Ignored for non-read actions. | | `get_by` | `list(atom) \| atom` | | Takes a list of fields and adds those fields as arguments, which will then be used to filter. Sets `get?` to true automatically. Ignored for non-read actions. |
| `get_by_identity` | `atom` | | Only relevant for read actions. Takes an identity, and gets its field list, performing the same logic as `get_by` once it has the list of fields. | | `get_by_identity` | `atom` | | Only relevant for read actions. Takes an identity, and gets its field list, performing the same logic as `get_by` once it has the list of fields. |
@ -1808,7 +1808,7 @@ define_calculation :referral_link, args: [{:arg, :id}, {:ref, :id}]
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `calculation` | `atom` | | The name of the calculation that will be evaluated. Defaults to the same name as the function. | | `calculation` | `atom` | | The name of the calculation that will be evaluated. Defaults to the same name as the function. |
| `args` | ``any`` | [] | Supply field or argument values referenced by the calculation, in the form of :name, `{:arg, :name}` and/or `{:ref, :name}`. See the [code interface guide](/documentation/topics/code-interface.md) for more. | | `args` | ``any`` | `[]` | Supply field or argument values referenced by the calculation, in the form of :name, `{:arg, :name}` and/or `{:ref, :name}`. See the [code interface guide](/documentation/topics/code-interface.md) for more. |
@ -1849,7 +1849,7 @@ end
| `short_name` | `atom` | | A short identifier for the resource, which should be unique. See the [monitoring guide](/documentation/topics/monitoring.md) for more. | | `short_name` | `atom` | | A short identifier for the resource, which should be unique. See the [monitoring guide](/documentation/topics/monitoring.md) for more. |
| `plural_name` | `atom` | | A pluralized version of the resource short_name. May be used by generators or automated tooling. | | `plural_name` | `atom` | | A pluralized version of the resource short_name. May be used by generators or automated tooling. |
| `simple_notifiers` | `list(module)` | | A list of notifiers that require no DSL. Can be used to avoid compile time dependencies on notifiers | | `simple_notifiers` | `list(module)` | | A list of notifiers that require no DSL. Can be used to avoid compile time dependencies on notifiers |
| `require_primary_key?` | `boolean` | true | Allow the resource to be used without any primary key fields. Warning: this option is experimental, and should not be used unless you know what you're doing. | | `require_primary_key?` | `boolean` | `true` | Allow the resource to be used without any primary key fields. Warning: this option is experimental, and should not be used unless you know what you're doing. |
@ -1977,10 +1977,10 @@ change {MyCustomChange, :foo}
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `on` | ``any`` | [:create, :update] | The action types the validation should run on. Destroy actions are omitted by default as most changes don't make sense for a destroy. | | `on` | ``any`` | `[:create, :update]` | The action types the validation should run on. Destroy actions are omitted by default as most changes don't make sense for a destroy. |
| `only_when_valid?` | `boolean` | false | If the change should only be run on valid changes. By default, all changes are run unless stated otherwise here. | | `only_when_valid?` | `boolean` | `false` | If the change should only be run on valid changes. By default, all changes are run unless stated otherwise here. |
| `description` | `String.t` | | An optional description for the change | | `description` | `String.t` | | An optional description for the change |
| `where` | `list((any -> any) \| module)` | [] | Validations that should pass in order for this validation to apply. These validations failing will result in this validation being ignored. | | `where` | `list((any -> any) \| module)` | `[]` | Validations that should pass in order for this validation to apply. These validations failing will result in this validation being ignored. |
@ -2100,12 +2100,12 @@ validate at_least_one_of_present([:first_name, :last_name])
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `where` | `list((any -> any) \| module) \| (any -> any) \| module` | [] | Validations that should pass in order for this validation to apply. Any of these validations failing will result in this validation being ignored. | | `where` | `list((any -> any) \| module) \| (any -> any) \| module` | `[]` | Validations that should pass in order for this validation to apply. Any of these validations failing will result in this validation being ignored. |
| `on` | ``any`` | [:create, :update] | The action types the validation should run on. Many validations don't make sense in the context of deletion, so by default it is not included. | | `on` | ``any`` | `[:create, :update]` | The action types the validation should run on. Many validations don't make sense in the context of deletion, so by default it is not included. |
| `only_when_valid?` | `boolean` | false | If the validation should only run on valid changes. Useful for expensive validations or validations that depend on valid data. | | `only_when_valid?` | `boolean` | `false` | If the validation should only run on valid changes. Useful for expensive validations or validations that depend on valid data. |
| `message` | `String.t` | | If provided, overrides any message set by the validation error | | `message` | `String.t` | | If provided, overrides any message set by the validation error |
| `description` | `String.t` | | An optional description for the validation | | `description` | `String.t` | | An optional description for the validation |
| `before_action?` | `boolean` | false | If set to `true`, the validation will be run in a before_action hook | | `before_action?` | `boolean` | `false` | If set to `true`, the validation will be run in a before_action hook |
@ -2186,15 +2186,15 @@ end
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `kind`* | `:count \| :first \| :sum \| :list \| :avg \| :max \| :min \| :exists \| :custom \| {:custom, module}` | | The kind of the aggregate | | `kind`* | `:count \| :first \| :sum \| :list \| :avg \| :max \| :min \| :exists \| :custom \| {:custom, module}` | | The kind of the aggregate |
| `uniq?` | `boolean` | false | Wether or not to count unique values only | | `uniq?` | `boolean` | `false` | Wether or not to count unique values only |
| `read_action` | `atom` | | The read action to use when building the aggregate. Defaults to the primary read action. Keep in mind this action must not have any required arguments. | | `read_action` | `atom` | | The read action to use when building the aggregate. Defaults to the primary read action. Keep in mind this action must not have any required arguments. |
| `field` | `atom` | | The field to aggregate. Defaults to the first field in the primary key of the resource | | `field` | `atom` | | The field to aggregate. Defaults to the first field in the primary key of the resource |
| `filter` | ``any`` | [] | A filter to apply to the aggregate | | `filter` | ``any`` | `[]` | A filter to apply to the aggregate |
| `description` | `String.t` | | An optional description for the aggregate | | `description` | `String.t` | | An optional description for the aggregate |
| `default` | ``any`` | | A default value to use in cases where nil would be used. Count defaults to `0`. | | `default` | ``any`` | | A default value to use in cases where nil would be used. Count defaults to `0`. |
| `private?` | `boolean` | false | Whether or not the aggregate will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql | | `private?` | `boolean` | `false` | Whether or not the aggregate will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql |
| `filterable?` | `boolean \| :simple_equality` | true | Whether or not the aggregate should be usable in filters. | | `filterable?` | `boolean \| :simple_equality` | `true` | Whether or not the aggregate should be usable in filters. |
| `authorize?` | `boolean` | true | Wether or not the aggregate query should authorize based on the target action, if the parent query is authorized. Requires filter checks on the target action. | | `authorize?` | `boolean` | `true` | Wether or not the aggregate query should authorize based on the target action, if the parent query is authorized. Requires filter checks on the target action. |
@ -2237,12 +2237,12 @@ exists :has_ticket, :assigned_tickets
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `kind`* | `:count \| :first \| :sum \| :list \| :avg \| :max \| :min \| :exists \| :custom \| {:custom, module}` | | The kind of the aggregate | | `kind`* | `:count \| :first \| :sum \| :list \| :avg \| :max \| :min \| :exists \| :custom \| {:custom, module}` | | The kind of the aggregate |
| `read_action` | `atom` | | The read action to use when building the aggregate. Defaults to the primary read action. Keep in mind this action must not have any required arguments. | | `read_action` | `atom` | | The read action to use when building the aggregate. Defaults to the primary read action. Keep in mind this action must not have any required arguments. |
| `filter` | ``any`` | [] | A filter to apply to the aggregate | | `filter` | ``any`` | `[]` | A filter to apply to the aggregate |
| `description` | `String.t` | | An optional description for the aggregate | | `description` | `String.t` | | An optional description for the aggregate |
| `default` | ``any`` | | A default value to use in cases where nil would be used. Count defaults to `0`. | | `default` | ``any`` | | A default value to use in cases where nil would be used. Count defaults to `0`. |
| `private?` | `boolean` | false | Whether or not the aggregate will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql | | `private?` | `boolean` | `false` | Whether or not the aggregate will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql |
| `filterable?` | `boolean \| :simple_equality` | true | Whether or not the aggregate should be usable in filters. | | `filterable?` | `boolean \| :simple_equality` | `true` | Whether or not the aggregate should be usable in filters. |
| `authorize?` | `boolean` | true | Wether or not the aggregate query should authorize based on the target action, if the parent query is authorized. Requires filter checks on the target action. | | `authorize?` | `boolean` | `true` | Wether or not the aggregate query should authorize based on the target action, if the parent query is authorized. Requires filter checks on the target action. |
@ -2290,13 +2290,13 @@ end
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `kind`* | `:count \| :first \| :sum \| :list \| :avg \| :max \| :min \| :exists \| :custom \| {:custom, module}` | | The kind of the aggregate | | `kind`* | `:count \| :first \| :sum \| :list \| :avg \| :max \| :min \| :exists \| :custom \| {:custom, module}` | | The kind of the aggregate |
| `read_action` | `atom` | | The read action to use when building the aggregate. Defaults to the primary read action. Keep in mind this action must not have any required arguments. | | `read_action` | `atom` | | The read action to use when building the aggregate. Defaults to the primary read action. Keep in mind this action must not have any required arguments. |
| `filter` | ``any`` | [] | A filter to apply to the aggregate | | `filter` | ``any`` | `[]` | A filter to apply to the aggregate |
| `sort` | ``any`` | | A sort to be applied to the aggregate | | `sort` | ``any`` | | A sort to be applied to the aggregate |
| `description` | `String.t` | | An optional description for the aggregate | | `description` | `String.t` | | An optional description for the aggregate |
| `default` | ``any`` | | A default value to use in cases where nil would be used. Count defaults to `0`. | | `default` | ``any`` | | A default value to use in cases where nil would be used. Count defaults to `0`. |
| `private?` | `boolean` | false | Whether or not the aggregate will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql | | `private?` | `boolean` | `false` | Whether or not the aggregate will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql |
| `filterable?` | `boolean \| :simple_equality` | true | Whether or not the aggregate should be usable in filters. | | `filterable?` | `boolean \| :simple_equality` | `true` | Whether or not the aggregate should be usable in filters. |
| `authorize?` | `boolean` | true | Wether or not the aggregate query should authorize based on the target action, if the parent query is authorized. Requires filter checks on the target action. | | `authorize?` | `boolean` | `true` | Wether or not the aggregate query should authorize based on the target action, if the parent query is authorized. Requires filter checks on the target action. |
@ -2342,12 +2342,12 @@ end
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `kind`* | `:count \| :first \| :sum \| :list \| :avg \| :max \| :min \| :exists \| :custom \| {:custom, module}` | | The kind of the aggregate | | `kind`* | `:count \| :first \| :sum \| :list \| :avg \| :max \| :min \| :exists \| :custom \| {:custom, module}` | | The kind of the aggregate |
| `read_action` | `atom` | | The read action to use when building the aggregate. Defaults to the primary read action. Keep in mind this action must not have any required arguments. | | `read_action` | `atom` | | The read action to use when building the aggregate. Defaults to the primary read action. Keep in mind this action must not have any required arguments. |
| `filter` | ``any`` | [] | A filter to apply to the aggregate | | `filter` | ``any`` | `[]` | A filter to apply to the aggregate |
| `description` | `String.t` | | An optional description for the aggregate | | `description` | `String.t` | | An optional description for the aggregate |
| `default` | ``any`` | | A default value to use in cases where nil would be used. Count defaults to `0`. | | `default` | ``any`` | | A default value to use in cases where nil would be used. Count defaults to `0`. |
| `private?` | `boolean` | false | Whether or not the aggregate will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql | | `private?` | `boolean` | `false` | Whether or not the aggregate will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql |
| `filterable?` | `boolean \| :simple_equality` | true | Whether or not the aggregate should be usable in filters. | | `filterable?` | `boolean \| :simple_equality` | `true` | Whether or not the aggregate should be usable in filters. |
| `authorize?` | `boolean` | true | Wether or not the aggregate query should authorize based on the target action, if the parent query is authorized. Requires filter checks on the target action. | | `authorize?` | `boolean` | `true` | Wether or not the aggregate query should authorize based on the target action, if the parent query is authorized. Requires filter checks on the target action. |
@ -2393,15 +2393,15 @@ end
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `kind`* | `:count \| :first \| :sum \| :list \| :avg \| :max \| :min \| :exists \| :custom \| {:custom, module}` | | The kind of the aggregate | | `kind`* | `:count \| :first \| :sum \| :list \| :avg \| :max \| :min \| :exists \| :custom \| {:custom, module}` | | The kind of the aggregate |
| `uniq?` | `boolean` | false | Wether or not to count unique values only | | `uniq?` | `boolean` | `false` | Wether or not to count unique values only |
| `read_action` | `atom` | | The read action to use when building the aggregate. Defaults to the primary read action. Keep in mind this action must not have any required arguments. | | `read_action` | `atom` | | The read action to use when building the aggregate. Defaults to the primary read action. Keep in mind this action must not have any required arguments. |
| `filter` | ``any`` | [] | A filter to apply to the aggregate | | `filter` | ``any`` | `[]` | A filter to apply to the aggregate |
| `sort` | ``any`` | | A sort to be applied to the aggregate | | `sort` | ``any`` | | A sort to be applied to the aggregate |
| `description` | `String.t` | | An optional description for the aggregate | | `description` | `String.t` | | An optional description for the aggregate |
| `default` | ``any`` | | A default value to use in cases where nil would be used. Count defaults to `0`. | | `default` | ``any`` | | A default value to use in cases where nil would be used. Count defaults to `0`. |
| `private?` | `boolean` | false | Whether or not the aggregate will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql | | `private?` | `boolean` | `false` | Whether or not the aggregate will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql |
| `filterable?` | `boolean \| :simple_equality` | true | Whether or not the aggregate should be usable in filters. | | `filterable?` | `boolean \| :simple_equality` | `true` | Whether or not the aggregate should be usable in filters. |
| `authorize?` | `boolean` | true | Wether or not the aggregate query should authorize based on the target action, if the parent query is authorized. Requires filter checks on the target action. | | `authorize?` | `boolean` | `true` | Wether or not the aggregate query should authorize based on the target action, if the parent query is authorized. Requires filter checks on the target action. |
@ -2447,12 +2447,12 @@ end
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `kind`* | `:count \| :first \| :sum \| :list \| :avg \| :max \| :min \| :exists \| :custom \| {:custom, module}` | | The kind of the aggregate | | `kind`* | `:count \| :first \| :sum \| :list \| :avg \| :max \| :min \| :exists \| :custom \| {:custom, module}` | | The kind of the aggregate |
| `read_action` | `atom` | | The read action to use when building the aggregate. Defaults to the primary read action. Keep in mind this action must not have any required arguments. | | `read_action` | `atom` | | The read action to use when building the aggregate. Defaults to the primary read action. Keep in mind this action must not have any required arguments. |
| `filter` | ``any`` | [] | A filter to apply to the aggregate | | `filter` | ``any`` | `[]` | A filter to apply to the aggregate |
| `description` | `String.t` | | An optional description for the aggregate | | `description` | `String.t` | | An optional description for the aggregate |
| `default` | ``any`` | | A default value to use in cases where nil would be used. Count defaults to `0`. | | `default` | ``any`` | | A default value to use in cases where nil would be used. Count defaults to `0`. |
| `private?` | `boolean` | false | Whether or not the aggregate will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql | | `private?` | `boolean` | `false` | Whether or not the aggregate will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql |
| `filterable?` | `boolean \| :simple_equality` | true | Whether or not the aggregate should be usable in filters. | | `filterable?` | `boolean \| :simple_equality` | `true` | Whether or not the aggregate should be usable in filters. |
| `authorize?` | `boolean` | true | Wether or not the aggregate query should authorize based on the target action, if the parent query is authorized. Requires filter checks on the target action. | | `authorize?` | `boolean` | `true` | Wether or not the aggregate query should authorize based on the target action, if the parent query is authorized. Requires filter checks on the target action. |
@ -2498,12 +2498,12 @@ end
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `kind`* | `:count \| :first \| :sum \| :list \| :avg \| :max \| :min \| :exists \| :custom \| {:custom, module}` | | The kind of the aggregate | | `kind`* | `:count \| :first \| :sum \| :list \| :avg \| :max \| :min \| :exists \| :custom \| {:custom, module}` | | The kind of the aggregate |
| `read_action` | `atom` | | The read action to use when building the aggregate. Defaults to the primary read action. Keep in mind this action must not have any required arguments. | | `read_action` | `atom` | | The read action to use when building the aggregate. Defaults to the primary read action. Keep in mind this action must not have any required arguments. |
| `filter` | ``any`` | [] | A filter to apply to the aggregate | | `filter` | ``any`` | `[]` | A filter to apply to the aggregate |
| `description` | `String.t` | | An optional description for the aggregate | | `description` | `String.t` | | An optional description for the aggregate |
| `default` | ``any`` | | A default value to use in cases where nil would be used. Count defaults to `0`. | | `default` | ``any`` | | A default value to use in cases where nil would be used. Count defaults to `0`. |
| `private?` | `boolean` | false | Whether or not the aggregate will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql | | `private?` | `boolean` | `false` | Whether or not the aggregate will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql |
| `filterable?` | `boolean \| :simple_equality` | true | Whether or not the aggregate should be usable in filters. | | `filterable?` | `boolean \| :simple_equality` | `true` | Whether or not the aggregate should be usable in filters. |
| `authorize?` | `boolean` | true | Wether or not the aggregate query should authorize based on the target action, if the parent query is authorized. Requires filter checks on the target action. | | `authorize?` | `boolean` | `true` | Wether or not the aggregate query should authorize based on the target action, if the parent query is authorized. Requires filter checks on the target action. |
@ -2549,12 +2549,12 @@ end
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `kind`* | `:count \| :first \| :sum \| :list \| :avg \| :max \| :min \| :exists \| :custom \| {:custom, module}` | | The kind of the aggregate | | `kind`* | `:count \| :first \| :sum \| :list \| :avg \| :max \| :min \| :exists \| :custom \| {:custom, module}` | | The kind of the aggregate |
| `read_action` | `atom` | | The read action to use when building the aggregate. Defaults to the primary read action. Keep in mind this action must not have any required arguments. | | `read_action` | `atom` | | The read action to use when building the aggregate. Defaults to the primary read action. Keep in mind this action must not have any required arguments. |
| `filter` | ``any`` | [] | A filter to apply to the aggregate | | `filter` | ``any`` | `[]` | A filter to apply to the aggregate |
| `description` | `String.t` | | An optional description for the aggregate | | `description` | `String.t` | | An optional description for the aggregate |
| `default` | ``any`` | | A default value to use in cases where nil would be used. Count defaults to `0`. | | `default` | ``any`` | | A default value to use in cases where nil would be used. Count defaults to `0`. |
| `private?` | `boolean` | false | Whether or not the aggregate will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql | | `private?` | `boolean` | `false` | Whether or not the aggregate will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql |
| `filterable?` | `boolean \| :simple_equality` | true | Whether or not the aggregate should be usable in filters. | | `filterable?` | `boolean \| :simple_equality` | `true` | Whether or not the aggregate should be usable in filters. |
| `authorize?` | `boolean` | true | Wether or not the aggregate query should authorize based on the target action, if the parent query is authorized. Requires filter checks on the target action. | | `authorize?` | `boolean` | `true` | Wether or not the aggregate query should authorize based on the target action, if the parent query is authorized. Requires filter checks on the target action. |
@ -2604,13 +2604,13 @@ end
| `kind`* | `:count \| :first \| :sum \| :list \| :avg \| :max \| :min \| :exists \| :custom \| {:custom, module}` | | The kind of the aggregate | | `kind`* | `:count \| :first \| :sum \| :list \| :avg \| :max \| :min \| :exists \| :custom \| {:custom, module}` | | The kind of the aggregate |
| `read_action` | `atom` | | The read action to use when building the aggregate. Defaults to the primary read action. Keep in mind this action must not have any required arguments. | | `read_action` | `atom` | | The read action to use when building the aggregate. Defaults to the primary read action. Keep in mind this action must not have any required arguments. |
| `field` | `atom` | | The field to aggregate. Defaults to the first field in the primary key of the resource | | `field` | `atom` | | The field to aggregate. Defaults to the first field in the primary key of the resource |
| `filter` | ``any`` | [] | A filter to apply to the aggregate | | `filter` | ``any`` | `[]` | A filter to apply to the aggregate |
| `sort` | ``any`` | | A sort to be applied to the aggregate | | `sort` | ``any`` | | A sort to be applied to the aggregate |
| `description` | `String.t` | | An optional description for the aggregate | | `description` | `String.t` | | An optional description for the aggregate |
| `default` | ``any`` | | A default value to use in cases where nil would be used. Count defaults to `0`. | | `default` | ``any`` | | A default value to use in cases where nil would be used. Count defaults to `0`. |
| `private?` | `boolean` | false | Whether or not the aggregate will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql | | `private?` | `boolean` | `false` | Whether or not the aggregate will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql |
| `filterable?` | `boolean \| :simple_equality` | true | Whether or not the aggregate should be usable in filters. | | `filterable?` | `boolean \| :simple_equality` | `true` | Whether or not the aggregate should be usable in filters. |
| `authorize?` | `boolean` | true | Wether or not the aggregate query should authorize based on the target action, if the parent query is authorized. Requires filter checks on the target action. | | `authorize?` | `boolean` | `true` | Wether or not the aggregate query should authorize based on the target action, if the parent query is authorized. Requires filter checks on the target action. |
@ -2694,13 +2694,13 @@ calculate :full_name, :string, expr(first_name <> " " <> last_name)
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `constraints` | `Keyword.t` | [] | Constraints to provide to the type. See `Ash.Type` for more. | | `constraints` | `Keyword.t` | `[]` | Constraints to provide to the type. See `Ash.Type` for more. |
| `description` | `String.t` | | An optional description for the calculation | | `description` | `String.t` | | An optional description for the calculation |
| `private?` | `boolean` | false | Whether or not the calculation will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql See the [security guide](/documentation/topics/security.md) for more. | | `private?` | `boolean` | `false` | Whether or not the calculation will appear in any interfaces created off of this resource, e.g AshJsonApi and AshGraphql See the [security guide](/documentation/topics/security.md) for more. |
| `select` | `list(atom)` | [] | A list of fields to ensure selected if the calculation is used. | | `select` | `list(atom)` | `[]` | A list of fields to ensure selected if the calculation is used. |
| `load` | ``any`` | [] | A load statement to be applied if the calculation is used. | | `load` | ``any`` | `[]` | A load statement to be applied if the calculation is used. |
| `allow_nil?` | `boolean` | true | Whether or not the calculation can return nil. | | `allow_nil?` | `boolean` | `true` | Whether or not the calculation can return nil. |
| `filterable?` | `boolean \| :simple_equality` | true | Whether or not the calculation should be usable in filters. | | `filterable?` | `boolean \| :simple_equality` | `true` | Whether or not the calculation should be usable in filters. |
## calculations.calculate.argument ## calculations.calculate.argument
@ -2742,9 +2742,9 @@ end
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `default` | `(-> any) \| mfa \| any()` | | A default value to use for the argument if not provided | | `default` | `(-> any) \| mfa \| any()` | | A default value to use for the argument if not provided |
| `allow_nil?` | `boolean` | true | Whether or not the argument value may be nil (or may be not provided) | | `allow_nil?` | `boolean` | `true` | Whether or not the argument value may be nil (or may be not provided) |
| `allow_expr?` | `boolean` | false | Allow passing expressions as argument values. Expressions cannot be type validated. | | `allow_expr?` | `boolean` | `false` | Allow passing expressions as argument values. Expressions cannot be type validated. |
| `constraints` | `Keyword.t` | [] | Constraints to provide to the type when casting the value. See the type's documentation and `Ash.Type` for more. | | `constraints` | `Keyword.t` | `[]` | Constraints to provide to the type when casting the value. See the type's documentation and `Ash.Type` for more. |
@ -2791,10 +2791,10 @@ end
### Options ### Options
| Name | Type | Default | Docs | | Name | Type | Default | Docs |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `strategy` | `:context \| :attribute` | :context | Determine if multitenancy is performed with attribute filters or using data layer features. | | `strategy` | `:context \| :attribute` | `:context` | Determine if multitenancy is performed with attribute filters or using data layer features. |
| `attribute` | `atom` | | If using the `attribute` strategy, the attribute to use, e.g `org_id` | | `attribute` | `atom` | | If using the `attribute` strategy, the attribute to use, e.g `org_id` |
| `global?` | `boolean` | false | Whether or not the data also exists outside of each tenant. | | `global?` | `boolean` | `false` | Whether or not the data also exists outside of each tenant. |
| `parse_attribute` | `mfa` | {Ash.Resource.Dsl, :identity, []} | An mfa ({module, function, args}) pointing to a function that takes a tenant and returns the attribute value | | `parse_attribute` | `mfa` | `{Ash.Resource.Dsl, :identity, []}` | An mfa ({module, function, args}) pointing to a function that takes a tenant and returns the attribute value |

4
mix.lock
View file

@ -30,8 +30,8 @@
"plug": {:hex, :plug, "1.14.2", "cff7d4ec45b4ae176a227acd94a7ab536d9b37b942c8e8fa6dfc0fff98ff4d80", [:mix], [{:mime, "~> 1.0 or ~> 2.0", [hex: :mime, repo: "hexpm", optional: false]}, {:plug_crypto, "~> 1.1.1 or ~> 1.2", [hex: :plug_crypto, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4.3 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "842fc50187e13cf4ac3b253d47d9474ed6c296a8732752835ce4a86acdf68d13"}, "plug": {:hex, :plug, "1.14.2", "cff7d4ec45b4ae176a227acd94a7ab536d9b37b942c8e8fa6dfc0fff98ff4d80", [:mix], [{:mime, "~> 1.0 or ~> 2.0", [hex: :mime, repo: "hexpm", optional: false]}, {:plug_crypto, "~> 1.1.1 or ~> 1.2", [hex: :plug_crypto, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4.3 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "842fc50187e13cf4ac3b253d47d9474ed6c296a8732752835ce4a86acdf68d13"},
"plug_crypto": {:hex, :plug_crypto, "1.2.5", "918772575e48e81e455818229bf719d4ab4181fcbf7f85b68a35620f78d89ced", [:mix], [], "hexpm", "26549a1d6345e2172eb1c233866756ae44a9609bd33ee6f99147ab3fd87fd842"}, "plug_crypto": {:hex, :plug_crypto, "1.2.5", "918772575e48e81e455818229bf719d4ab4181fcbf7f85b68a35620f78d89ced", [:mix], [], "hexpm", "26549a1d6345e2172eb1c233866756ae44a9609bd33ee6f99147ab3fd87fd842"},
"sobelow": {:hex, :sobelow, "0.13.0", "218afe9075904793f5c64b8837cc356e493d88fddde126a463839351870b8d1e", [:mix], [{:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "cd6e9026b85fc35d7529da14f95e85a078d9dd1907a9097b3ba6ac7ebbe34a0d"}, "sobelow": {:hex, :sobelow, "0.13.0", "218afe9075904793f5c64b8837cc356e493d88fddde126a463839351870b8d1e", [:mix], [{:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "cd6e9026b85fc35d7529da14f95e85a078d9dd1907a9097b3ba6ac7ebbe34a0d"},
"sourceror": {:hex, :sourceror, "0.13.0", "c6ecc96ee3ae0e042e9082a9550a1989ea40182492dc29024a8d9d2b136e5014", [:mix], [], "hexpm", "d0a819491061cd26bfa4450d1c84301a410c19c1782a6577ce15853fc0e7e4e1"}, "sourceror": {:hex, :sourceror, "0.14.0", "b6b8552d0240400d66b6f107c1bab7ac1726e998efc797f178b7b517e928e314", [:mix], [], "hexpm", "809c71270ad48092d40bbe251a133e49ae229433ce103f762a2373b7a10a8d8b"},
"spark": {:hex, :spark, "1.1.36", "a4cc1168fe94c24c90fbb3521921c4d3f9ec86642f84adc6da5ae62426189edd", [:mix], [{:jason, "~> 1.4", [hex: :jason, repo: "hexpm", optional: false]}, {:nimble_options, "~> 0.5 or ~> 1.0", [hex: :nimble_options, repo: "hexpm", optional: false]}, {:sourceror, "~> 0.1", [hex: :sourceror, repo: "hexpm", optional: false]}], "hexpm", "ce03b3167f85fdc4416c9c5cee4aac4cc0ca8715d115631b68669be5e2e890f7"}, "spark": {:hex, :spark, "1.1.39", "f143b84a5b796bf2d83ec8fb4793ee9e66e67510c40d785f9a67050bb88e7677", [:mix], [{:jason, "~> 1.4", [hex: :jason, repo: "hexpm", optional: false]}, {:nimble_options, "~> 0.5 or ~> 1.0", [hex: :nimble_options, repo: "hexpm", optional: false]}, {:sourceror, "~> 0.1", [hex: :sourceror, repo: "hexpm", optional: false]}], "hexpm", "d71bc26014c7e7abcdcf553f4cf7c5a5ff96f8365b1e20be3768ce503aafb203"},
"statistex": {:hex, :statistex, "1.0.0", "f3dc93f3c0c6c92e5f291704cf62b99b553253d7969e9a5fa713e5481cd858a5", [:mix], [], "hexpm", "ff9d8bee7035028ab4742ff52fc80a2aa35cece833cf5319009b52f1b5a86c27"}, "statistex": {:hex, :statistex, "1.0.0", "f3dc93f3c0c6c92e5f291704cf62b99b553253d7969e9a5fa713e5481cd858a5", [:mix], [], "hexpm", "ff9d8bee7035028ab4742ff52fc80a2aa35cece833cf5319009b52f1b5a86c27"},
"stream_data": {:hex, :stream_data, "0.6.0", "e87a9a79d7ec23d10ff83eb025141ef4915eeb09d4491f79e52f2562b73e5f47", [:mix], [], "hexpm", "b92b5031b650ca480ced047578f1d57ea6dd563f5b57464ad274718c9c29501c"}, "stream_data": {:hex, :stream_data, "0.6.0", "e87a9a79d7ec23d10ff83eb025141ef4915eeb09d4491f79e52f2562b73e5f47", [:mix], [], "hexpm", "b92b5031b650ca480ced047578f1d57ea6dd563f5b57464ad274718c9c29501c"},
"telemetry": {:hex, :telemetry, "1.2.1", "68fdfe8d8f05a8428483a97d7aab2f268aaff24b49e0f599faa091f1d4e7f61c", [:rebar3], [], "hexpm", "dad9ce9d8effc621708f99eac538ef1cbe05d6a874dd741de2e689c47feafed5"}, "telemetry": {:hex, :telemetry, "1.2.1", "68fdfe8d8f05a8428483a97d7aab2f268aaff24b49e0f599faa091f1d4e7f61c", [:rebar3], [], "hexpm", "dad9ce9d8effc621708f99eac538ef1cbe05d6a874dd741de2e689c47feafed5"},