2023-09-27 16:13:40 +13:00
<!--
This file was generated by Spark. Do not edit it by hand.
-->
2023-09-15 09:16:35 +12:00
# DSL: Ash.Flow.Dsl
The built in flow DSL.
## Halting
Steps can be halted, which will stop the flow from continuing and return a halted flow. To attach a specific reason, use a `halt_reason`.
If you need more complex halting logic, then you'd want to use a custom step, and return `{:error, Ash.Error.Flow.Halted.exception(...)}`
## flow
Details about the flow itself, like description and the successful return type.
2023-09-16 04:16:54 +12:00
### Nested DSLs
2023-09-15 09:16:35 +12:00
* [argument](#flow-argument)
2023-09-16 04:16:54 +12:00
2023-09-15 09:16:35 +12:00
### Options
2023-09-27 16:13:40 +13:00
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th colspan=2>Docs</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">
<a id="flow-api" href="#flow-api">
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
api
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">module</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
An api to use by default when calling actions
</td>
</tr>
<tr>
<td style="text-align: left">
<a id="flow-description" href="#flow-description">
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
description
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">String.t</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A description of the flow
</td>
</tr>
<tr>
<td style="text-align: left">
<a id="flow-trace_name" href="#flow-trace_name">
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
trace_name
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">String.t</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
The name to use when creating traces. Defaults to the short name.
</td>
</tr>
<tr>
<td style="text-align: left">
<a id="flow-short_name" href="#flow-short_name">
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
short_name
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">atom</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A short name to use for the flow. Defaults to the last to parts of the module name, underscored.
</td>
</tr>
<tr>
<td style="text-align: left">
<a id="flow-returns" href="#flow-returns">
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
returns
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
The step or step that should constitute the return value.
</td>
</tr>
</tbody>
</table>
2023-09-15 09:16:35 +12:00
## flow.argument
2023-09-16 03:41:41 +12:00
```elixir
argument name, type
```
2023-09-15 09:16:35 +12:00
An argument to be passed into the flow
### Examples
```
argument :params, :map do
default %{}
end
```
```
argument :retries, :integer do
allow_nil? false
end
```
2023-10-12 02:30:22 +13:00
### Arguments
2023-09-27 16:13:40 +13:00
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th colspan=2>Docs</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="flow-argument-name" href="#flow-argument-name">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
name
</span>
</a>
<sup style="color: red">*</sup>
</td>
<td style="text-align: left">
<code class="inline">atom</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
The name to use for the argument
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="flow-argument-type" href="#flow-argument-type">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
type
</span>
</a>
<sup style="color: red">*</sup>
</td>
<td style="text-align: left">
<code class="inline">module</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
The type of the argument. See `Ash.Type` for more.
</td>
</tr>
2023-10-12 02:30:22 +13:00
</tbody>
</table>
### Options
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th colspan=2>Docs</th>
</tr>
</thead>
<tbody>
<tr>
2023-09-27 16:13:40 +13:00
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="flow-argument-default" href="#flow-argument-default">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
default
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">(-> any) | mfa | any()</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A default value to use for the argument if not provided
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="flow-argument-allow_nil?" href="#flow-argument-allow_nil?">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
allow_nil?
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">boolean</code>
</td>
<td style="text-align: left">
<code class="inline">true</code>
</td>
<td style="text-align: left" colspan=2>
Whether or not the argument value may be nil
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="flow-argument-constraints" href="#flow-argument-constraints">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
constraints
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">Keyword.t</code>
</td>
<td style="text-align: left">
<code class="inline">[]</code>
</td>
<td style="text-align: left" colspan=2>
Constraints to provide to the type when casting the value. See the type's documentation for more information.
</td>
</tr>
</tbody>
</table>
2023-09-15 09:16:35 +12:00
### Introspection
Target: `Ash.Flow.Argument`
## steps
2023-09-16 04:16:54 +12:00
The steps to run.
2023-09-15 09:16:35 +12:00
2023-09-16 04:16:54 +12:00
### Nested DSLs
2023-09-15 09:16:35 +12:00
* [map](#steps-map)
* [branch](#steps-branch)
* [transaction](#steps-transaction)
* [create](#steps-create)
* [debug](#steps-debug)
* [update](#steps-update)
* [destroy](#steps-destroy)
* [validate](#steps-validate)
* [read](#steps-read)
* [run_flow](#steps-run_flow)
* [custom](#steps-custom)
2023-09-16 04:16:54 +12:00
2023-09-15 09:16:35 +12:00
### Examples
```
steps do
# invokes a create action
create :create_post, MyApp.Post, :create
end
```
## steps.map
2023-09-16 03:41:41 +12:00
```elixir
map name, over
```
2023-09-15 09:16:35 +12:00
Runs a set of steps for each item in a provided list.
### Examples
```
map :create_users, range(1, arg(:count)) do
output :create_user
create :create_user, Org, :create do
input %{
first_name: {Faker.Person, :first_name, []},
last_name: {Faker.Person, :last_name, []}
}
end
end
```
2023-10-12 02:30:22 +13:00
### Arguments
2023-09-27 16:13:40 +13:00
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th colspan=2>Docs</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-map-name" href="#steps-map-name">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
name
</span>
</a>
<sup style="color: red">*</sup>
</td>
<td style="text-align: left">
<code class="inline">atom</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
The name of the step. Will be used when expressing dependencies, and step inputs.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-map-over" href="#steps-map-over">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
over
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
The value to be iterated over. Will be available inside the `map` step as `element(:map_step_name)`
</td>
</tr>
2023-10-12 02:30:22 +13:00
</tbody>
</table>
### Options
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th colspan=2>Docs</th>
</tr>
</thead>
<tbody>
<tr>
2023-09-27 16:13:40 +13:00
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-map-output" href="#steps-map-output">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
output
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">atom</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Which step to use when constructing the output list. Defaults to the last step.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-map-short_name" href="#steps-map-short_name">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
short_name
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">String.t</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Set a short name for the step. Will be used when building things like mermaid charts.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-map-wait_for" href="#steps-map-wait_for">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
wait_for
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-map-touches_resources" href="#steps-map-touches_resources">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
touches_resources
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">list(atom)</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
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.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-map-halt_if" href="#steps-map-halt_if">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
halt_if
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-map-halt_reason" href="#steps-map-halt_reason">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
halt_reason
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
<code class="inline">:halted</code>
</td>
<td style="text-align: left" colspan=2>
Configures the reason for the `halt_if` clause.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-map-description" href="#steps-map-description">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
description
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">String.t</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A description for the step.
</td>
</tr>
</tbody>
</table>
2023-09-15 09:16:35 +12:00
### Introspection
Target: `Ash.Flow.Step.Map`
## steps.branch
2023-09-16 03:41:41 +12:00
```elixir
branch name, condition
```
2023-09-15 09:16:35 +12:00
Runs a set of steps based on a given value.
### Examples
```
branch :create_users, result(:create_users?) do
output :create_user
create :create_user, Org, :create do
input %{
first_name: {Faker.Person, :first_name, []},
last_name: {Faker.Person, :last_name, []}
}
end
end
```
2023-10-12 02:30:22 +13:00
### Arguments
2023-09-27 16:13:40 +13:00
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th colspan=2>Docs</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-branch-name" href="#steps-branch-name">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
name
</span>
</a>
<sup style="color: red">*</sup>
</td>
<td style="text-align: left">
<code class="inline">atom</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
The name of the step. Will be used when expressing dependencies, and step inputs.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-branch-condition" href="#steps-branch-condition">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
condition
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A template that must evaluate to `true` for the branch to be executed.
</td>
</tr>
2023-10-12 02:30:22 +13:00
</tbody>
</table>
### Options
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th colspan=2>Docs</th>
</tr>
</thead>
<tbody>
<tr>
2023-09-27 16:13:40 +13:00
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-branch-output" href="#steps-branch-output">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
output
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">atom</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Which step to use as the output. Defaults to the last step.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-branch-short_name" href="#steps-branch-short_name">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
short_name
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">String.t</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Set a short name for the step. Will be used when building things like mermaid charts.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-branch-wait_for" href="#steps-branch-wait_for">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
wait_for
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-branch-touches_resources" href="#steps-branch-touches_resources">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
touches_resources
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">list(atom)</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
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.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-branch-halt_if" href="#steps-branch-halt_if">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
halt_if
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-branch-halt_reason" href="#steps-branch-halt_reason">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
halt_reason
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
<code class="inline">:halted</code>
</td>
<td style="text-align: left" colspan=2>
Configures the reason for the `halt_if` clause.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-branch-description" href="#steps-branch-description">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
description
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">String.t</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A description for the step.
</td>
</tr>
</tbody>
</table>
2023-09-15 09:16:35 +12:00
### Introspection
Target: `Ash.Flow.Step.Branch`
## steps.transaction
2023-09-16 03:41:41 +12:00
```elixir
transaction name, resource
```
2023-09-15 09:16:35 +12:00
Runs a set of steps in a transaction.
### Examples
```
transaction :create_users do
create :create_user, User, :create do
input %{
first_name: {Faker.Person, :first_name, []},
last_name: {Faker.Person, :last_name, []}
}
end
create :create_user, Org, :create do
input %{
first_name: {Faker.Person, :first_name, []},
last_name: {Faker.Person, :last_name, []}
}
end
end
```
2023-10-12 02:30:22 +13:00
### Arguments
2023-09-27 16:13:40 +13:00
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th colspan=2>Docs</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-transaction-name" href="#steps-transaction-name">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
name
</span>
</a>
<sup style="color: red">*</sup>
</td>
<td style="text-align: left">
<code class="inline">atom</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
The name of the step. Will be used when expressing dependencies, and step inputs.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-transaction-resource" href="#steps-transaction-resource">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
2023-10-12 02:30:22 +13:00
resource
2023-09-27 16:13:40 +13:00
</span>
</a>
</td>
<td style="text-align: left">
2023-10-26 10:45:55 +13:00
<code class="inline">module | list(module)</code>
2023-09-27 16:13:40 +13:00
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
2023-10-12 02:30:22 +13:00
The Ash resource to use for the transaction.
2023-09-27 16:13:40 +13:00
</td>
</tr>
2023-10-12 02:30:22 +13:00
</tbody>
</table>
### Options
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th colspan=2>Docs</th>
</tr>
</thead>
<tbody>
<tr>
2023-09-27 16:13:40 +13:00
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-transaction-output" href="#steps-transaction-output">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
2023-10-12 02:30:22 +13:00
output
2023-09-27 16:13:40 +13:00
</span>
</a>
</td>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<code class="inline">`any`</code>
2023-09-27 16:13:40 +13:00
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
2023-10-12 02:30:22 +13:00
Which step or steps to use when constructing the output. Defaults to the last step.
2023-09-27 16:13:40 +13:00
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-transaction-timeout" href="#steps-transaction-timeout">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
2023-10-12 02:30:22 +13:00
timeout
2023-09-27 16:13:40 +13:00
</span>
</a>
</td>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<code class="inline">timeout</code>
2023-09-27 16:13:40 +13:00
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
2023-10-12 02:30:22 +13:00
A timeout to apply to the transaction.
2023-09-27 16:13:40 +13:00
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-transaction-short_name" href="#steps-transaction-short_name">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
short_name
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">String.t</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Set a short name for the step. Will be used when building things like mermaid charts.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-transaction-wait_for" href="#steps-transaction-wait_for">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
wait_for
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-transaction-touches_resources" href="#steps-transaction-touches_resources">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
touches_resources
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">list(atom)</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
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.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-transaction-halt_if" href="#steps-transaction-halt_if">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
halt_if
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-transaction-halt_reason" href="#steps-transaction-halt_reason">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
halt_reason
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
<code class="inline">:halted</code>
</td>
<td style="text-align: left" colspan=2>
Configures the reason for the `halt_if` clause.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-transaction-description" href="#steps-transaction-description">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
description
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">String.t</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A description for the step.
</td>
</tr>
</tbody>
</table>
2023-09-15 09:16:35 +12:00
### Introspection
Target: `Ash.Flow.Step.Transaction`
## steps.create
2023-09-16 03:41:41 +12:00
```elixir
create name, resource, action
```
2023-09-15 09:16:35 +12:00
Declares a step that will call a create action on a resource.
### Examples
```
create :create_post, MyApp.Post, :create
```
2023-10-12 02:30:22 +13:00
### Arguments
2023-09-27 16:13:40 +13:00
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th colspan=2>Docs</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-create-name" href="#steps-create-name">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
name
</span>
</a>
<sup style="color: red">*</sup>
</td>
<td style="text-align: left">
<code class="inline">atom</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
The name of the step. Will be used when expressing dependencies, and step inputs.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-create-resource" href="#steps-create-resource">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
resource
</span>
</a>
<sup style="color: red">*</sup>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
The resource to call the action on.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-create-action" href="#steps-create-action">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
action
</span>
</a>
<sup style="color: red">*</sup>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
The action to call on the resource.
</td>
</tr>
2023-10-12 02:30:22 +13:00
</tbody>
</table>
### Options
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th colspan=2>Docs</th>
</tr>
</thead>
<tbody>
<tr>
2023-09-27 16:13:40 +13:00
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-create-upsert?" href="#steps-create-upsert?">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
upsert?
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">boolean</code>
</td>
<td style="text-align: left">
<code class="inline">false</code>
</td>
<td style="text-align: left" colspan=2>
Wether or not this action is always an upsert.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-create-upsert_identity" href="#steps-create-upsert_identity">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
upsert_identity
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">atom</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
The identity to use for the upsert.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-create-short_name" href="#steps-create-short_name">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
short_name
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">String.t</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Set a short name for the step. Will be used when building things like mermaid charts.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-create-wait_for" href="#steps-create-wait_for">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
wait_for
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-create-touches_resources" href="#steps-create-touches_resources">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
touches_resources
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">list(atom)</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
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.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-create-halt_if" href="#steps-create-halt_if">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
halt_if
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-create-halt_reason" href="#steps-create-halt_reason">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
halt_reason
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
<code class="inline">:halted</code>
</td>
<td style="text-align: left" colspan=2>
Configures the reason for the `halt_if` clause.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-create-description" href="#steps-create-description">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
description
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">String.t</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A description for the step.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-create-api" href="#steps-create-api">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
api
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
The api to use when calling the action. Defaults to the api set in the `flow` section.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-create-tenant" href="#steps-create-tenant">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
tenant
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A tenant to use for the operation. May be a template or a literal value.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-create-input" href="#steps-create-input">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
input
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A template for the input.
</td>
</tr>
</tbody>
</table>
2023-09-15 09:16:35 +12:00
### Introspection
Target: `Ash.Flow.Step.Create`
## steps.debug
2023-09-16 03:41:41 +12:00
```elixir
debug name
```
2023-09-15 09:16:35 +12:00
Declares a step that will inspect its input and provide
additional debug information.
### Examples
```
debug :show_some_information do
input %{post: result(:create_post)}
end
```
2023-10-12 02:30:22 +13:00
### Arguments
2023-09-27 16:13:40 +13:00
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th colspan=2>Docs</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-debug-name" href="#steps-debug-name">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
name
</span>
</a>
<sup style="color: red">*</sup>
</td>
<td style="text-align: left">
<code class="inline">atom</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
The name of the step. Will be used when expressing dependencies, and step inputs.
</td>
</tr>
2023-10-12 02:30:22 +13:00
</tbody>
</table>
### Options
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th colspan=2>Docs</th>
</tr>
</thead>
<tbody>
<tr>
2023-09-27 16:13:40 +13:00
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-debug-input" href="#steps-debug-input">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
input
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A template for the input.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-debug-short_name" href="#steps-debug-short_name">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
short_name
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">String.t</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Set a short name for the step. Will be used when building things like mermaid charts.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-debug-wait_for" href="#steps-debug-wait_for">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
wait_for
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-debug-halt_if" href="#steps-debug-halt_if">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
halt_if
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-debug-halt_reason" href="#steps-debug-halt_reason">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
halt_reason
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
<code class="inline">:halted</code>
</td>
<td style="text-align: left" colspan=2>
Configures the reason for the `halt_if` clause.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-debug-description" href="#steps-debug-description">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
description
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">String.t</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A description for the step.
</td>
</tr>
</tbody>
</table>
2023-09-15 09:16:35 +12:00
### Introspection
Target: `Ash.Flow.Step.Debug`
## steps.update
2023-09-16 03:41:41 +12:00
```elixir
update name, resource, action
```
2023-09-15 09:16:35 +12:00
Declares a step that will call a update action on a resource.
### Examples
```
update :update_post, MyApp.Post, :update do
record result(:get_post)
end
```
2023-10-12 02:30:22 +13:00
### Arguments
2023-09-27 16:13:40 +13:00
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th colspan=2>Docs</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-update-name" href="#steps-update-name">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
2023-10-12 02:30:22 +13:00
name
2023-09-27 16:13:40 +13:00
</span>
</a>
<sup style="color: red">*</sup>
</td>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<code class="inline">atom</code>
2023-09-27 16:13:40 +13:00
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
2023-10-12 02:30:22 +13:00
The name of the step. Will be used when expressing dependencies, and step inputs.
2023-09-27 16:13:40 +13:00
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-update-resource" href="#steps-update-resource">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
2023-10-12 02:30:22 +13:00
resource
2023-09-27 16:13:40 +13:00
</span>
</a>
<sup style="color: red">*</sup>
</td>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<code class="inline">`any`</code>
2023-09-27 16:13:40 +13:00
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
2023-10-12 02:30:22 +13:00
The resource to call the action on.
2023-09-27 16:13:40 +13:00
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-update-action" href="#steps-update-action">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
2023-10-12 02:30:22 +13:00
action
2023-09-27 16:13:40 +13:00
</span>
</a>
<sup style="color: red">*</sup>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
2023-10-12 02:30:22 +13:00
The action to call on the resource.
2023-09-27 16:13:40 +13:00
</td>
</tr>
2023-10-12 02:30:22 +13:00
</tbody>
</table>
### Options
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th colspan=2>Docs</th>
</tr>
</thead>
<tbody>
<tr>
2023-09-27 16:13:40 +13:00
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-update-record" href="#steps-update-record">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
2023-10-12 02:30:22 +13:00
record
2023-09-27 16:13:40 +13:00
</span>
</a>
<sup style="color: red">*</sup>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
2023-10-12 02:30:22 +13:00
The record to be updated, can use template helpers, e.g `result(:step_name)`.
2023-09-27 16:13:40 +13:00
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-update-short_name" href="#steps-update-short_name">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
short_name
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">String.t</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Set a short name for the step. Will be used when building things like mermaid charts.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-update-wait_for" href="#steps-update-wait_for">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
wait_for
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-update-touches_resources" href="#steps-update-touches_resources">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
touches_resources
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">list(atom)</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
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.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-update-halt_if" href="#steps-update-halt_if">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
halt_if
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-update-halt_reason" href="#steps-update-halt_reason">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
halt_reason
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
<code class="inline">:halted</code>
</td>
<td style="text-align: left" colspan=2>
Configures the reason for the `halt_if` clause.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-update-description" href="#steps-update-description">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
description
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">String.t</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A description for the step.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-update-api" href="#steps-update-api">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
api
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
The api to use when calling the action. Defaults to the api set in the `flow` section.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-update-tenant" href="#steps-update-tenant">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
tenant
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A tenant to use for the operation. May be a template or a literal value.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-update-input" href="#steps-update-input">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
input
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A template for the input.
</td>
</tr>
</tbody>
</table>
2023-09-15 09:16:35 +12:00
### Introspection
Target: `Ash.Flow.Step.Update`
## steps.destroy
2023-09-16 03:41:41 +12:00
```elixir
destroy name, resource, action
```
2023-09-15 09:16:35 +12:00
Declares a step that will call a destroy action on a resource.
### Examples
```
destroy :destroy_post, MyApp.Post, :destroy
```
2023-10-12 02:30:22 +13:00
### Arguments
2023-09-27 16:13:40 +13:00
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th colspan=2>Docs</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-destroy-name" href="#steps-destroy-name">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
2023-10-12 02:30:22 +13:00
name
2023-09-27 16:13:40 +13:00
</span>
</a>
<sup style="color: red">*</sup>
</td>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<code class="inline">atom</code>
2023-09-27 16:13:40 +13:00
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
2023-10-12 02:30:22 +13:00
The name of the step. Will be used when expressing dependencies, and step inputs.
2023-09-27 16:13:40 +13:00
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-destroy-resource" href="#steps-destroy-resource">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
2023-10-12 02:30:22 +13:00
resource
2023-09-27 16:13:40 +13:00
</span>
</a>
<sup style="color: red">*</sup>
</td>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<code class="inline">`any`</code>
2023-09-27 16:13:40 +13:00
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
2023-10-12 02:30:22 +13:00
The resource to call the action on.
2023-09-27 16:13:40 +13:00
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-destroy-action" href="#steps-destroy-action">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
2023-10-12 02:30:22 +13:00
action
2023-09-27 16:13:40 +13:00
</span>
</a>
<sup style="color: red">*</sup>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
2023-10-12 02:30:22 +13:00
The action to call on the resource.
2023-09-27 16:13:40 +13:00
</td>
</tr>
2023-10-12 02:30:22 +13:00
</tbody>
</table>
### Options
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th colspan=2>Docs</th>
</tr>
</thead>
<tbody>
<tr>
2023-09-27 16:13:40 +13:00
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-destroy-record" href="#steps-destroy-record">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
2023-10-12 02:30:22 +13:00
record
2023-09-27 16:13:40 +13:00
</span>
</a>
<sup style="color: red">*</sup>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
2023-10-12 02:30:22 +13:00
The record to be updated, can use template helpers, e.g `result(:step_name)`.
2023-09-27 16:13:40 +13:00
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-destroy-short_name" href="#steps-destroy-short_name">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
short_name
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">String.t</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Set a short name for the step. Will be used when building things like mermaid charts.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-destroy-wait_for" href="#steps-destroy-wait_for">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
wait_for
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-destroy-touches_resources" href="#steps-destroy-touches_resources">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
touches_resources
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">list(atom)</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
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.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-destroy-halt_if" href="#steps-destroy-halt_if">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
halt_if
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-destroy-halt_reason" href="#steps-destroy-halt_reason">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
halt_reason
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
<code class="inline">:halted</code>
</td>
<td style="text-align: left" colspan=2>
Configures the reason for the `halt_if` clause.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-destroy-description" href="#steps-destroy-description">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
description
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">String.t</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A description for the step.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-destroy-api" href="#steps-destroy-api">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
api
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
The api to use when calling the action. Defaults to the api set in the `flow` section.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-destroy-tenant" href="#steps-destroy-tenant">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
tenant
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A tenant to use for the operation. May be a template or a literal value.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-destroy-input" href="#steps-destroy-input">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
input
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A template for the input.
</td>
</tr>
</tbody>
</table>
2023-09-15 09:16:35 +12:00
### Introspection
Target: `Ash.Flow.Step.Destroy`
## steps.validate
2023-09-16 03:41:41 +12:00
```elixir
validate name, resource, action
```
2023-09-15 09:16:35 +12:00
Validates some input against an action.
### Examples
```
validate :update_post, MyApp.Post, :update do
record result(:get_post)
only_keys [:name]
end
```
2023-10-12 02:30:22 +13:00
### Arguments
2023-09-27 16:13:40 +13:00
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th colspan=2>Docs</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-validate-name" href="#steps-validate-name">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
name
</span>
</a>
<sup style="color: red">*</sup>
</td>
<td style="text-align: left">
<code class="inline">atom</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
The name of the step. Will be used when expressing dependencies, and step inputs.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-validate-resource" href="#steps-validate-resource">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
resource
</span>
</a>
<sup style="color: red">*</sup>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
The resource to call the action on.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-validate-action" href="#steps-validate-action">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
action
</span>
</a>
<sup style="color: red">*</sup>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
The action to call on the resource.
</td>
</tr>
2023-10-12 02:30:22 +13:00
</tbody>
</table>
### Options
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th colspan=2>Docs</th>
</tr>
</thead>
<tbody>
<tr>
2023-09-27 16:13:40 +13:00
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-validate-record" href="#steps-validate-record">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
record
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
The record to be created/updated/destroyed. If the value is `nil` and would be required by the action type, the step is skipped and `nil` is the result of the step.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-validate-only_keys" href="#steps-validate-only_keys">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
only_keys
</span>
</a>
</td>
<td style="text-align: left">
2023-10-26 10:45:55 +13:00
<code class="inline">list(atom | list(atom))</code>
2023-09-27 16:13:40 +13:00
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A list of keys or paths to keys that should be validated. Others will be ignored, and errors generated for other fields will be ignored.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-validate-short_name" href="#steps-validate-short_name">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
short_name
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">String.t</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Set a short name for the step. Will be used when building things like mermaid charts.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-validate-wait_for" href="#steps-validate-wait_for">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
wait_for
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-validate-touches_resources" href="#steps-validate-touches_resources">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
touches_resources
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">list(atom)</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
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.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-validate-halt_if" href="#steps-validate-halt_if">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
halt_if
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-validate-halt_reason" href="#steps-validate-halt_reason">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
halt_reason
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
<code class="inline">:halted</code>
</td>
<td style="text-align: left" colspan=2>
Configures the reason for the `halt_if` clause.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-validate-description" href="#steps-validate-description">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
description
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">String.t</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A description for the step.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-validate-api" href="#steps-validate-api">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
api
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
The api to use when calling the action. Defaults to the api set in the `flow` section.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-validate-tenant" href="#steps-validate-tenant">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
tenant
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A tenant to use for the operation. May be a template or a literal value.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-validate-input" href="#steps-validate-input">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
input
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A template for the input.
</td>
</tr>
</tbody>
</table>
2023-09-15 09:16:35 +12:00
### Introspection
Target: `Ash.Flow.Step.Update`
## steps.read
2023-09-16 03:41:41 +12:00
```elixir
read name, resource, action
```
2023-09-15 09:16:35 +12:00
Declares a step that will call a read action on a resource.
### Examples
```
read :destroy_post, MyApp.Post, :destroy
```
2023-10-12 02:30:22 +13:00
### Arguments
2023-09-27 16:13:40 +13:00
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th colspan=2>Docs</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-read-name" href="#steps-read-name">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
name
</span>
</a>
<sup style="color: red">*</sup>
</td>
<td style="text-align: left">
<code class="inline">atom</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
The name of the step. Will be used when expressing dependencies, and step inputs.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-read-resource" href="#steps-read-resource">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
resource
</span>
</a>
<sup style="color: red">*</sup>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
The resource to call the action on.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-read-action" href="#steps-read-action">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
action
</span>
</a>
<sup style="color: red">*</sup>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
The action to call on the resource.
</td>
</tr>
2023-10-12 02:30:22 +13:00
</tbody>
</table>
### Options
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th colspan=2>Docs</th>
</tr>
</thead>
<tbody>
<tr>
2023-09-27 16:13:40 +13:00
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-read-get?" href="#steps-read-get?">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
get?
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">boolean</code>
</td>
<td style="text-align: left">
<code class="inline">false</code>
</td>
<td style="text-align: left" colspan=2>
Whether or not read action is expected to return a single result or `nil`. Set to `true` automatically if `get? true`.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-read-not_found_error?" href="#steps-read-not_found_error?">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
not_found_error?
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">boolean</code>
</td>
<td style="text-align: left">
<code class="inline">true</code>
</td>
<td style="text-align: left" colspan=2>
Whether or not finding no record should result in a not found error
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-read-short_name" href="#steps-read-short_name">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
short_name
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">String.t</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Set a short name for the step. Will be used when building things like mermaid charts.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-read-wait_for" href="#steps-read-wait_for">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
wait_for
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-read-touches_resources" href="#steps-read-touches_resources">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
touches_resources
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">list(atom)</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
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.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-read-halt_if" href="#steps-read-halt_if">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
halt_if
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-read-halt_reason" href="#steps-read-halt_reason">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
halt_reason
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
<code class="inline">:halted</code>
</td>
<td style="text-align: left" colspan=2>
Configures the reason for the `halt_if` clause.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-read-description" href="#steps-read-description">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
description
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">String.t</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A description for the step.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-read-api" href="#steps-read-api">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
api
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
The api to use when calling the action. Defaults to the api set in the `flow` section.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-read-tenant" href="#steps-read-tenant">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
tenant
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A tenant to use for the operation. May be a template or a literal value.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-read-input" href="#steps-read-input">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
input
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A template for the input.
</td>
</tr>
</tbody>
</table>
2023-09-15 09:16:35 +12:00
### Introspection
Target: `Ash.Flow.Step.Read`
## steps.run_flow
2023-09-16 03:41:41 +12:00
```elixir
run_flow name, flow
```
2023-09-15 09:16:35 +12:00
Runs another flow as part of the current flow.
The return value of the step is the return value of the flow.
### Examples
```
run_flow :get_org, GetOrgByName do
input %{
name: arg(:org_name)
}
```
2023-10-12 02:30:22 +13:00
### Arguments
2023-09-27 16:13:40 +13:00
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th colspan=2>Docs</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-run_flow-name" href="#steps-run_flow-name">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
2023-10-12 02:30:22 +13:00
name
2023-09-27 16:13:40 +13:00
</span>
</a>
<sup style="color: red">*</sup>
</td>
<td style="text-align: left">
<code class="inline">atom</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
2023-10-12 02:30:22 +13:00
The name of the step. Will be used when expressing dependencies, and step inputs.
2023-09-27 16:13:40 +13:00
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-run_flow-flow" href="#steps-run_flow-flow">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
2023-10-12 02:30:22 +13:00
flow
2023-09-27 16:13:40 +13:00
</span>
</a>
<sup style="color: red">*</sup>
</td>
<td style="text-align: left">
<code class="inline">atom</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
2023-10-12 02:30:22 +13:00
The flow to run.
2023-09-27 16:13:40 +13:00
</td>
</tr>
2023-10-12 02:30:22 +13:00
</tbody>
</table>
### Options
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th colspan=2>Docs</th>
</tr>
</thead>
<tbody>
<tr>
2023-09-27 16:13:40 +13:00
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-run_flow-input" href="#steps-run_flow-input">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
input
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A template for the input.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-run_flow-short_name" href="#steps-run_flow-short_name">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
short_name
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">String.t</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Set a short name for the step. Will be used when building things like mermaid charts.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-run_flow-wait_for" href="#steps-run_flow-wait_for">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
wait_for
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-run_flow-touches_resources" href="#steps-run_flow-touches_resources">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
touches_resources
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">list(atom)</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
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.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-run_flow-halt_if" href="#steps-run_flow-halt_if">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
halt_if
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-run_flow-halt_reason" href="#steps-run_flow-halt_reason">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
halt_reason
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
<code class="inline">:halted</code>
</td>
<td style="text-align: left" colspan=2>
Configures the reason for the `halt_if` clause.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-run_flow-description" href="#steps-run_flow-description">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
description
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">String.t</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A description for the step.
</td>
</tr>
</tbody>
</table>
2023-09-15 09:16:35 +12:00
### Introspection
Target: `Ash.Flow.Step.RunFlow`
## steps.custom
2023-09-16 03:41:41 +12:00
```elixir
custom name, custom
```
2023-09-15 09:16:35 +12:00
Runs a custom step module.
See `Ash.Flow.Step` for the necessary callbacks and more information.
### Examples
```
custom :do_custom_thing, MyApp.DoCustomThing do
input %{...}
end
```
```
custom :do_custom_thing, {MyApp.DoCustomThing, opt1: :foo, opt2: :bar} do
input %{...}
end
```
### Arguments
2023-09-27 16:13:40 +13:00
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th colspan=2>Docs</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-custom-name" href="#steps-custom-name">
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
name
</span>
</a>
<sup style="color: red">*</sup>
</td>
<td style="text-align: left">
<code class="inline">atom</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
The name of the step. Will be used when expressing dependencies, and step inputs.
</td>
</tr>
<tr>
<td style="text-align: left">
<a id="steps-custom-custom" href="#steps-custom-custom">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
custom
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">(any, any -> any) | module</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
The module that implements the step behaviour. Also accepts a 2 argument function that takes the input and the context.
</td>
</tr>
</tbody>
</table>
2023-09-15 09:16:35 +12:00
### Options
2023-09-27 16:13:40 +13:00
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th colspan=2>Docs</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-custom-input" href="#steps-custom-input">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
input
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A template for the input.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-custom-async?" href="#steps-custom-async?">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
async?
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">boolean</code>
</td>
<td style="text-align: left">
<code class="inline">false</code>
</td>
<td style="text-align: left" colspan=2>
Whether or not this step can be run outside of the current process.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-custom-short_name" href="#steps-custom-short_name">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
short_name
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">String.t</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Set a short name for the step. Will be used when building things like mermaid charts.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-custom-wait_for" href="#steps-custom-wait_for">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
wait_for
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Ensures that the step happens after the configured step or steps. This is a template who's results are not used, only awaited.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-custom-touches_resources" href="#steps-custom-touches_resources">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
touches_resources
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">list(atom)</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
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.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-custom-halt_if" href="#steps-custom-halt_if">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
halt_if
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
Halts the step by emitting an error (with an `Ash.Error.Flow.Halted`). Can use template variables. See the section on Halting for more.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-custom-halt_reason" href="#steps-custom-halt_reason">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
halt_reason
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">`any`</code>
</td>
<td style="text-align: left">
<code class="inline">:halted</code>
</td>
<td style="text-align: left" colspan=2>
Configures the reason for the `halt_if` clause.
</td>
</tr>
<tr>
<td style="text-align: left">
2023-10-12 02:30:22 +13:00
<a id="steps-custom-description" href="#steps-custom-description">
2023-09-27 16:13:40 +13:00
<span style="font-family: Inconsolata, Menlo, Courier, monospace;">
description
</span>
</a>
</td>
<td style="text-align: left">
<code class="inline">String.t</code>
</td>
<td style="text-align: left">
</td>
<td style="text-align: left" colspan=2>
A description for the step.
</td>
</tr>
</tbody>
</table>
2023-09-15 09:16:35 +12:00
### Introspection
Target: `Ash.Flow.Step.Custom`
