documentation/dsls/DSL-AshOps.md

Select File:
documentation/dsls/DSL-AshOps.md

<!--
This file was generated by Spark. Do not edit it by hand.
-->
# AshOps

An extension for `Ash.Domain` that adds the ability expose resource actions as
mix tasks.


## mix_tasks
Resource actions to expose as mix tasks.


### Nested DSLs
 * [action](#mix_tasks-action)
 * [create](#mix_tasks-create)
 * [destroy](#mix_tasks-destroy)
 * [get](#mix_tasks-get)
 * [list](#mix_tasks-list)
 * [update](#mix_tasks-update)


### Examples
```
mix_tasks do
  action Post, :publish_post, :publish
  create Post, :create_post, :create
  destroy Post, :destroy_post, :destroy
  get Post, :get_post, :read
  list Post, :list_posts, :read
  update Post, :update_post, :update
end

```




### mix_tasks.action
```elixir
action resource, name, action
```


Generate a mix task which calls a generic action and returns the created
record.

#### Example

Defining the following `action` in your domain:

```elixir
mix_tasks do
action Post, :publish_post, :publish, arguments: [:id, :platform]
end
```

Will result in the following mix task being available:

```bash
mix my_app.blog.publish_post <ID> <platform>
```






### Arguments

| Name | Type | Default | Docs |
|------|------|---------|------|
| [`resource`](#mix_tasks-action-resource){: #mix_tasks-action-resource .spark-required} | `module` |  | The resource whose actions to use |
| [`name`](#mix_tasks-action-name){: #mix_tasks-action-name .spark-required} | `atom` |  | The name of the mix task to generate |
| [`action`](#mix_tasks-action-action){: #mix_tasks-action-action .spark-required} | `atom` |  | The name of the action to use |
### Options

| Name | Type | Default | Docs |
|------|------|---------|------|
| [`arguments`](#mix_tasks-action-arguments){: #mix_tasks-action-arguments } | `atom \| list(atom)` | `[]` | A list of action arguments which should be taken as positional arguments on the command line |
| [`description`](#mix_tasks-action-description){: #mix_tasks-action-description } | `String.t` |  | Documentation to be displayed in the mix task's help section |
| [`prefix`](#mix_tasks-action-prefix){: #mix_tasks-action-prefix } | `atom` |  | The prefix to use for the mix task name (ie the part before the first "."). Defaults to the `otp_app` setting of the domain |





### Introspection

Target: `AshOps.Entity.Action`

### mix_tasks.create
```elixir
create resource, name, action
```


Generate a mix task which calls a create action and returns the created
record.

#### Example

Defining the following `create` in your domain:

```elixir
mix_tasks do
create Post, :create_post, :create
end
```

Will result in the following mix task being available:

```bash
mix my_app.blog.create_post
```






### Arguments

| Name | Type | Default | Docs |
|------|------|---------|------|
| [`resource`](#mix_tasks-create-resource){: #mix_tasks-create-resource .spark-required} | `module` |  | The resource whose actions to use |
| [`name`](#mix_tasks-create-name){: #mix_tasks-create-name .spark-required} | `atom` |  | The name of the mix task to generate |
| [`action`](#mix_tasks-create-action){: #mix_tasks-create-action .spark-required} | `atom` |  | The name of the create action to use |
### Options

| Name | Type | Default | Docs |
|------|------|---------|------|
| [`description`](#mix_tasks-create-description){: #mix_tasks-create-description } | `String.t` |  | Documentation to be displayed in the mix task's help section |
| [`prefix`](#mix_tasks-create-prefix){: #mix_tasks-create-prefix } | `atom` |  | The prefix to use for the mix task name (ie the part before the first "."). Defaults to the `otp_app` setting of the domain |





### Introspection

Target: `AshOps.Entity.Create`

### mix_tasks.destroy
```elixir
destroy resource, name, action
```


Generate a mix task which calls a destroy action and removes a single record
by primary key or identity.

#### Example

Defining the following `destroy` in your domain:

```elixir
mix_tasks do
destroy Post, :destroy_post, :destroy
end
```

Will result in the following mix task being available:

```bash
mix my_app.blog.destroy_post "01953abc-c4e9-7661-a79a-243b0d982ab7"
status: ok
```






### Arguments

| Name | Type | Default | Docs |
|------|------|---------|------|
| [`resource`](#mix_tasks-destroy-resource){: #mix_tasks-destroy-resource .spark-required} | `module` |  | The resource whose action to use |
| [`name`](#mix_tasks-destroy-name){: #mix_tasks-destroy-name .spark-required} | `atom` |  | The name of the mix task to generate |
| [`action`](#mix_tasks-destroy-action){: #mix_tasks-destroy-action .spark-required} | `atom` |  | The name of the destroy action to use |
### Options

| Name | Type | Default | Docs |
|------|------|---------|------|
| [`arguments`](#mix_tasks-destroy-arguments){: #mix_tasks-destroy-arguments } | `atom \| list(atom)` | `[]` | A list of action arguments which should be taken as positional arguments on the command line |
| [`description`](#mix_tasks-destroy-description){: #mix_tasks-destroy-description } | `String.t` |  | Documentation to be displayed in the mix task's help section |
| [`prefix`](#mix_tasks-destroy-prefix){: #mix_tasks-destroy-prefix } | `atom` |  | The prefix to use for the mix task name (ie the part before the first ".").  Defaults to the `otp_app` setting of the domain |
| [`read_action`](#mix_tasks-destroy-read_action){: #mix_tasks-destroy-read_action } | `atom` |  | The read action to use to query for matching records to destroy. Defaults to the primary read action. |





### Introspection

Target: `AshOps.Entity.Destroy`

### mix_tasks.get
```elixir
get resource, name, action
```


Generate a mix task which calls a read action and returns a single record
by primary key or identity.

#### Example

Defining the following `get` in your domain:

```elixir
mix_tasks do
get Post, :get_post, :read
end
```

Will result in the following mix task being available:

```bash
mix my_app.blog.get_post "01953abc-c4e9-7661-a79a-243b0d982ab7"
title: Example blog post
body: This is the example blog post
```






### Arguments

| Name | Type | Default | Docs |
|------|------|---------|------|
| [`resource`](#mix_tasks-get-resource){: #mix_tasks-get-resource .spark-required} | `module` |  | The resource whose action to use |
| [`name`](#mix_tasks-get-name){: #mix_tasks-get-name .spark-required} | `atom` |  | The name of the mix task to generate |
| [`action`](#mix_tasks-get-action){: #mix_tasks-get-action .spark-required} | `atom` |  | The name of the read action to use |
### Options

| Name | Type | Default | Docs |
|------|------|---------|------|
| [`arguments`](#mix_tasks-get-arguments){: #mix_tasks-get-arguments } | `atom \| list(atom)` | `[]` | A list of action arguments which should be taken as positional arguments on the command line |
| [`description`](#mix_tasks-get-description){: #mix_tasks-get-description } | `String.t` |  | Documentation to be displayed in the mix task's help section |
| [`prefix`](#mix_tasks-get-prefix){: #mix_tasks-get-prefix } | `atom` |  | The prefix to use for the mix task name (ie the part before the first ".").  Defaults to the `otp_app` setting of the domain |





### Introspection

Target: `AshOps.Entity.Get`

### mix_tasks.list
```elixir
list resource, name, action
```


Generate a mix task which calls a read action and returns any matching records.

#### Example

Define the following `list` in your domain:application

```elixir
mix_tasks do
list Post, :list_posts, :read
end
```

Will result in the following mix task being available:application

```bash
mix my_app.blog.list_posts
```






### Arguments

| Name | Type | Default | Docs |
|------|------|---------|------|
| [`resource`](#mix_tasks-list-resource){: #mix_tasks-list-resource .spark-required} | `module` |  | The resource whose action to use |
| [`name`](#mix_tasks-list-name){: #mix_tasks-list-name .spark-required} | `atom` |  | The name of the mix task to generate |
| [`action`](#mix_tasks-list-action){: #mix_tasks-list-action .spark-required} | `atom` |  | The name of the read action to use |
### Options

| Name | Type | Default | Docs |
|------|------|---------|------|
| [`arguments`](#mix_tasks-list-arguments){: #mix_tasks-list-arguments } | `atom \| list(atom)` |  | A comma-separated list of action arguments can be taken as positional arguments on the command line |
| [`description`](#mix_tasks-list-description){: #mix_tasks-list-description } | `String.t` |  | Documentation to be displayed in the mix task's help section |
| [`prefix`](#mix_tasks-list-prefix){: #mix_tasks-list-prefix } | `atom` |  | The prefix to use for the mix task name (ie the part before the first ".").  Defaults to the `otp_app` setting of the domain |





### Introspection

Target: `AshOps.Entity.List`

### mix_tasks.update
```elixir
update resource, name, action
```


Generate a mix task which calls an update action and updates a single record
by primary key or identity.

#### Example

Defining the following `update` in your domain:

```elixir
mix_tasks do
update Post, :update_post, :update
end
```

Will result in the following mix task being available:

```bash
mix my_app.blog.update_post "01953abc-c4e9-7661-a79a-243b0d982ab7"
```






### Arguments

| Name | Type | Default | Docs |
|------|------|---------|------|
| [`resource`](#mix_tasks-update-resource){: #mix_tasks-update-resource .spark-required} | `module` |  | The resource whose action to use |
| [`name`](#mix_tasks-update-name){: #mix_tasks-update-name .spark-required} | `atom` |  | The name of the mix task to generate |
| [`action`](#mix_tasks-update-action){: #mix_tasks-update-action .spark-required} | `atom` |  | The name of the destroy action to use |
### Options

| Name | Type | Default | Docs |
|------|------|---------|------|
| [`arguments`](#mix_tasks-update-arguments){: #mix_tasks-update-arguments } | `atom \| list(atom)` | `[]` | A list of action arguments which should be taken as positional arguments on the command line |
| [`description`](#mix_tasks-update-description){: #mix_tasks-update-description } | `String.t` |  | Documentation to be displayed in the mix task's help section |
| [`prefix`](#mix_tasks-update-prefix){: #mix_tasks-update-prefix } | `atom` |  | The prefix to use for the mix task name (ie the part before the first ".").  Defaults to the `otp_app` setting of the domain |
| [`read_action`](#mix_tasks-update-read_action){: #mix_tasks-update-read_action } | `atom` |  | The read action to use to query for matching records to update. Defaults to the primary read action. |





### Introspection

Target: `AshOps.Entity.Update`





<style type="text/css">.spark-required::after { content: "*"; color: red !important; }</style>