Skip to content

feat: bulk update #439

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ken-kost wants to merge 6 commits into
base: main
Choose a base branch
from
Open

feat: bulk update #439

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8cc4aed
Implement bulk_update controller
ken-kost Jun 4, 2026
6313c42
Support bulk errors
ken-kost Jun 4, 2026
4532773
Support bulk update
ken-kost Jun 4, 2026
96d8e8e
Update documentation
ken-kost Jun 4, 2026
8ab3855
Expand formatter
ken-kost Jun 4, 2026
af5ebff
Add bulk update tests
ken-kost Jun 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .formatter.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ spark_locals_without_parens = [
base_route: 1,
base_route: 2,
base_route: 3,
batch_size: 1,
bulk_update: 1,
bulk_update: 2,
bulk_update: 3,
calculation_argument_names: 1,
default_fields: 1,
delete: 1,
Expand Down Expand Up @@ -41,6 +45,7 @@ spark_locals_without_parens = [
name: 1,
paginate?: 1,
paginated_includes: 1,
partial_success_status: 1,
patch: 1,
patch: 2,
patch: 3,
Expand Down Expand Up @@ -76,7 +81,9 @@ spark_locals_without_parens = [
router: 1,
serve_schema?: 1,
show_raised_errors?: 1,
success_status: 1,
tag: 1,
transaction: 1,
type: 1,
upsert?: 1,
upsert_identity: 1,
Expand Down
125 changes: 125 additions & 0 deletions documentation/dsls/DSL-AshJsonApi.Domain.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Global configuration for JSON:API
* index
* post
* patch
* bulk_update
* delete
* related
* relationship
Expand All @@ -29,6 +30,7 @@ Global configuration for JSON:API
* index
* post
* patch
* bulk_update
* delete
* related
* relationship
Expand Down Expand Up @@ -104,6 +106,7 @@ Configure the routes that will be exposed via the JSON:API
* index
* post
* patch
* bulk_update
* delete
* related
* relationship
Expand All @@ -115,6 +118,7 @@ Configure the routes that will be exposed via the JSON:API
* [index](#json_api-routes-index)
* [post](#json_api-routes-post)
* [patch](#json_api-routes-patch)
* [bulk_update](#json_api-routes-bulk_update)
* [delete](#json_api-routes-delete)
* [related](#json_api-routes-related)
* [relationship](#json_api-routes-relationship)
Expand Down Expand Up @@ -160,6 +164,7 @@ Sets a prefix for a list of contained routes
* [index](#json_api-routes-base_route-index)
* [post](#json_api-routes-base_route-post)
* [patch](#json_api-routes-base_route-patch)
* [bulk_update](#json_api-routes-base_route-bulk_update)
* [delete](#json_api-routes-base_route-delete)
* [related](#json_api-routes-base_route-related)
* [relationship](#json_api-routes-base_route-relationship)
Expand Down Expand Up @@ -393,6 +398,66 @@ patch :update, path_param_is_composite_key: :id



### Introspection

Target: `AshJsonApi.Resource.Route`

### json_api.routes.base_route.bulk_update
```elixir
bulk_update resource \\ nil, action
```


A route to bulk-update records from an array request body. Supports per-record (non-atomic, partial success) and transactional batch (all-or-nothing) updates.



### Examples
```
bulk_update :update
```

```
bulk_update :update, transaction: :all
```

```
bulk_update :update, route: "/bulk"
```



### Arguments

| Name | Type | Default | Docs |
|------|------|---------|------|
| [`resource`](#json_api-routes-base_route-bulk_update-resource){: #json_api-routes-base_route-bulk_update-resource } | `module` | | The resource that the route's action is defined on |
| [`action`](#json_api-routes-base_route-bulk_update-action){: #json_api-routes-base_route-bulk_update-action .spark-required} | `atom` | | The action to call when this route is hit |
### Options

| Name | Type | Default | Docs |
|------|------|---------|------|
| [`route`](#json_api-routes-base_route-bulk_update-route){: #json_api-routes-base_route-bulk_update-route } | `String.t` | `"/bulk"` | The path of the route |
| [`default_fields`](#json_api-routes-base_route-bulk_update-default_fields){: #json_api-routes-base_route-bulk_update-default_fields } | `list(atom)` | | A list of fields to be shown in the attributes of the called route |
| [`primary?`](#json_api-routes-base_route-bulk_update-primary?){: #json_api-routes-base_route-bulk_update-primary? } | `boolean` | `false` | Whether or not this is the route that should be linked to by default when rendering links to this type of route |
| [`metadata`](#json_api-routes-base_route-bulk_update-metadata){: #json_api-routes-base_route-bulk_update-metadata } | `(any, any, any -> any)` | | A function to generate arbitrary top-level metadata for the JSON:API response |
| [`modify_conn`](#json_api-routes-base_route-bulk_update-modify_conn){: #json_api-routes-base_route-bulk_update-modify_conn } | `(any, any, any, any -> any)` | | A function to modify the conn before responding. Used for things like setting headers based on the response. Takes `conn, subject, result, request`. See the modify_conn guide for more details and examples. |
| [`action_names_in_schema`](#json_api-routes-base_route-bulk_update-action_names_in_schema){: #json_api-routes-base_route-bulk_update-action_names_in_schema } | `keyword` | | A mapping of action names to how they should appear in the OpenAPI schema. You only need to set this if you see a warning during schema generation. |
| [`name`](#json_api-routes-base_route-bulk_update-name){: #json_api-routes-base_route-bulk_update-name } | `String.t` | | A globally unique name for this route, to be used when generating docs and open api specifications |
| [`description`](#json_api-routes-base_route-bulk_update-description){: #json_api-routes-base_route-bulk_update-description } | `String.t` | | A human-friendly description of this specific route to use in generated documentation and OpenAPI. If provided, this overrides the action description. |
| [`derive_sort?`](#json_api-routes-base_route-bulk_update-derive_sort?){: #json_api-routes-base_route-bulk_update-derive_sort? } | `boolean` | `true` | Whether or not to derive a sort parameter based on the sortable fields of the resource |
| [`derive_filter?`](#json_api-routes-base_route-bulk_update-derive_filter?){: #json_api-routes-base_route-bulk_update-derive_filter? } | `boolean` | `true` | Whether or not to derive a filter parameter based on the sortable fields of the resource |
| [`path_param_is_composite_key`](#json_api-routes-base_route-bulk_update-path_param_is_composite_key){: #json_api-routes-base_route-bulk_update-path_param_is_composite_key } | `atom` | | The path parameter that should be parsed as a composite primary key. When specified (e.g., :id), the parameter will be split using the resource's primary key delimiter and mapped to individual primary key fields. This is required for resources with composite primary keys to work correctly with GET, PATCH, and DELETE operations. See the composite primary keys documentation for more details. |
| [`transaction`](#json_api-routes-base_route-bulk_update-transaction){: #json_api-routes-base_route-bulk_update-transaction } | `:per_record \| :batch \| :all \| false` | `:per_record` | How to wrap the bulk update. `:per_record`/`false` are non-atomic — each record commits independently so successes persist when other records fail (partial success → multi-status). `:batch`/`:all` are atomic — any failure rolls the whole request back (all-or-nothing). |
| [`batch_size`](#json_api-routes-base_route-bulk_update-batch_size){: #json_api-routes-base_route-bulk_update-batch_size } | `pos_integer` | | The number of records to update per batch, passed through to `Ash.update_all/3`. |
| [`success_status`](#json_api-routes-base_route-bulk_update-success_status){: #json_api-routes-base_route-bulk_update-success_status } | `integer` | `200` | The HTTP status code to use when every record succeeds. |
| [`partial_success_status`](#json_api-routes-base_route-bulk_update-partial_success_status){: #json_api-routes-base_route-bulk_update-partial_success_status } | `integer` | `207` | The HTTP status code to use when some records succeed and some fail (per-record mode only). |
| [`read_action`](#json_api-routes-base_route-bulk_update-read_action){: #json_api-routes-base_route-bulk_update-read_action } | `atom` | | The read action to use to look the records up before updating |





### Introspection

Target: `AshJsonApi.Resource.Route`
Expand Down Expand Up @@ -959,6 +1024,66 @@ patch :update, path_param_is_composite_key: :id



### Introspection

Target: `AshJsonApi.Resource.Route`

### json_api.routes.bulk_update
```elixir
bulk_update resource, action
```


A route to bulk-update records from an array request body. Supports per-record (non-atomic, partial success) and transactional batch (all-or-nothing) updates.



### Examples
```
bulk_update :update
```

```
bulk_update :update, transaction: :all
```

```
bulk_update :update, route: "/bulk"
```



### Arguments

| Name | Type | Default | Docs |
|------|------|---------|------|
| [`resource`](#json_api-routes-bulk_update-resource){: #json_api-routes-bulk_update-resource } | `module` | | The resource that the route's action is defined on |
| [`action`](#json_api-routes-bulk_update-action){: #json_api-routes-bulk_update-action .spark-required} | `atom` | | The action to call when this route is hit |
### Options

| Name | Type | Default | Docs |
|------|------|---------|------|
| [`route`](#json_api-routes-bulk_update-route){: #json_api-routes-bulk_update-route } | `String.t` | `"/bulk"` | The path of the route |
| [`default_fields`](#json_api-routes-bulk_update-default_fields){: #json_api-routes-bulk_update-default_fields } | `list(atom)` | | A list of fields to be shown in the attributes of the called route |
| [`primary?`](#json_api-routes-bulk_update-primary?){: #json_api-routes-bulk_update-primary? } | `boolean` | `false` | Whether or not this is the route that should be linked to by default when rendering links to this type of route |
| [`metadata`](#json_api-routes-bulk_update-metadata){: #json_api-routes-bulk_update-metadata } | `(any, any, any -> any)` | | A function to generate arbitrary top-level metadata for the JSON:API response |
| [`modify_conn`](#json_api-routes-bulk_update-modify_conn){: #json_api-routes-bulk_update-modify_conn } | `(any, any, any, any -> any)` | | A function to modify the conn before responding. Used for things like setting headers based on the response. Takes `conn, subject, result, request`. See the modify_conn guide for more details and examples. |
| [`action_names_in_schema`](#json_api-routes-bulk_update-action_names_in_schema){: #json_api-routes-bulk_update-action_names_in_schema } | `keyword` | | A mapping of action names to how they should appear in the OpenAPI schema. You only need to set this if you see a warning during schema generation. |
| [`name`](#json_api-routes-bulk_update-name){: #json_api-routes-bulk_update-name } | `String.t` | | A globally unique name for this route, to be used when generating docs and open api specifications |
| [`description`](#json_api-routes-bulk_update-description){: #json_api-routes-bulk_update-description } | `String.t` | | A human-friendly description of this specific route to use in generated documentation and OpenAPI. If provided, this overrides the action description. |
| [`derive_sort?`](#json_api-routes-bulk_update-derive_sort?){: #json_api-routes-bulk_update-derive_sort? } | `boolean` | `true` | Whether or not to derive a sort parameter based on the sortable fields of the resource |
| [`derive_filter?`](#json_api-routes-bulk_update-derive_filter?){: #json_api-routes-bulk_update-derive_filter? } | `boolean` | `true` | Whether or not to derive a filter parameter based on the sortable fields of the resource |
| [`path_param_is_composite_key`](#json_api-routes-bulk_update-path_param_is_composite_key){: #json_api-routes-bulk_update-path_param_is_composite_key } | `atom` | | The path parameter that should be parsed as a composite primary key. When specified (e.g., :id), the parameter will be split using the resource's primary key delimiter and mapped to individual primary key fields. This is required for resources with composite primary keys to work correctly with GET, PATCH, and DELETE operations. See the composite primary keys documentation for more details. |
| [`transaction`](#json_api-routes-bulk_update-transaction){: #json_api-routes-bulk_update-transaction } | `:per_record \| :batch \| :all \| false` | `:per_record` | How to wrap the bulk update. `:per_record`/`false` are non-atomic — each record commits independently so successes persist when other records fail (partial success → multi-status). `:batch`/`:all` are atomic — any failure rolls the whole request back (all-or-nothing). |
| [`batch_size`](#json_api-routes-bulk_update-batch_size){: #json_api-routes-bulk_update-batch_size } | `pos_integer` | | The number of records to update per batch, passed through to `Ash.update_all/3`. |
| [`success_status`](#json_api-routes-bulk_update-success_status){: #json_api-routes-bulk_update-success_status } | `integer` | `200` | The HTTP status code to use when every record succeeds. |
| [`partial_success_status`](#json_api-routes-bulk_update-partial_success_status){: #json_api-routes-bulk_update-partial_success_status } | `integer` | `207` | The HTTP status code to use when some records succeed and some fail (per-record mode only). |
| [`read_action`](#json_api-routes-bulk_update-read_action){: #json_api-routes-bulk_update-read_action } | `atom` | | The read action to use to look the records up before updating |





### Introspection

Target: `AshJsonApi.Resource.Route`
Expand Down
61 changes: 61 additions & 0 deletions documentation/dsls/DSL-AshJsonApi.Resource.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Configure the resource's behavior in the JSON:API
* index
* post
* patch
* bulk_update
* delete
* related
* relationship
Expand Down Expand Up @@ -84,6 +85,7 @@ Configure the routes that will be exposed via the JSON:API
* [index](#json_api-routes-index)
* [post](#json_api-routes-post)
* [patch](#json_api-routes-patch)
* [bulk_update](#json_api-routes-bulk_update)
* [delete](#json_api-routes-delete)
* [related](#json_api-routes-related)
* [relationship](#json_api-routes-relationship)
Expand Down Expand Up @@ -319,6 +321,65 @@ patch :update, path_param_is_composite_key: :id



### Introspection

Target: `AshJsonApi.Resource.Route`

### json_api.routes.bulk_update
```elixir
bulk_update action
```


A route to bulk-update records from an array request body. Supports per-record (non-atomic, partial success) and transactional batch (all-or-nothing) updates.



### Examples
```
bulk_update :update
```

```
bulk_update :update, transaction: :all
```

```
bulk_update :update, route: "/bulk"
```



### Arguments

| Name | Type | Default | Docs |
|------|------|---------|------|
| [`action`](#json_api-routes-bulk_update-action){: #json_api-routes-bulk_update-action .spark-required} | `atom` | | The action to call when this route is hit |
### Options

| Name | Type | Default | Docs |
|------|------|---------|------|
| [`route`](#json_api-routes-bulk_update-route){: #json_api-routes-bulk_update-route } | `String.t` | `"/bulk"` | The path of the route |
| [`default_fields`](#json_api-routes-bulk_update-default_fields){: #json_api-routes-bulk_update-default_fields } | `list(atom)` | | A list of fields to be shown in the attributes of the called route |
| [`primary?`](#json_api-routes-bulk_update-primary?){: #json_api-routes-bulk_update-primary? } | `boolean` | `false` | Whether or not this is the route that should be linked to by default when rendering links to this type of route |
| [`metadata`](#json_api-routes-bulk_update-metadata){: #json_api-routes-bulk_update-metadata } | `(any, any, any -> any)` | | A function to generate arbitrary top-level metadata for the JSON:API response |
| [`modify_conn`](#json_api-routes-bulk_update-modify_conn){: #json_api-routes-bulk_update-modify_conn } | `(any, any, any, any -> any)` | | A function to modify the conn before responding. Used for things like setting headers based on the response. Takes `conn, subject, result, request`. See the modify_conn guide for more details and examples. |
| [`action_names_in_schema`](#json_api-routes-bulk_update-action_names_in_schema){: #json_api-routes-bulk_update-action_names_in_schema } | `keyword` | | A mapping of action names to how they should appear in the OpenAPI schema. You only need to set this if you see a warning during schema generation. |
| [`name`](#json_api-routes-bulk_update-name){: #json_api-routes-bulk_update-name } | `String.t` | | A globally unique name for this route, to be used when generating docs and open api specifications |
| [`description`](#json_api-routes-bulk_update-description){: #json_api-routes-bulk_update-description } | `String.t` | | A human-friendly description of this specific route to use in generated documentation and OpenAPI. If provided, this overrides the action description. |
| [`derive_sort?`](#json_api-routes-bulk_update-derive_sort?){: #json_api-routes-bulk_update-derive_sort? } | `boolean` | `true` | Whether or not to derive a sort parameter based on the sortable fields of the resource |
| [`derive_filter?`](#json_api-routes-bulk_update-derive_filter?){: #json_api-routes-bulk_update-derive_filter? } | `boolean` | `true` | Whether or not to derive a filter parameter based on the sortable fields of the resource |
| [`path_param_is_composite_key`](#json_api-routes-bulk_update-path_param_is_composite_key){: #json_api-routes-bulk_update-path_param_is_composite_key } | `atom` | | The path parameter that should be parsed as a composite primary key. When specified (e.g., :id), the parameter will be split using the resource's primary key delimiter and mapped to individual primary key fields. This is required for resources with composite primary keys to work correctly with GET, PATCH, and DELETE operations. See the composite primary keys documentation for more details. |
| [`transaction`](#json_api-routes-bulk_update-transaction){: #json_api-routes-bulk_update-transaction } | `:per_record \| :batch \| :all \| false` | `:per_record` | How to wrap the bulk update. `:per_record`/`false` are non-atomic — each record commits independently so successes persist when other records fail (partial success → multi-status). `:batch`/`:all` are atomic — any failure rolls the whole request back (all-or-nothing). |
| [`batch_size`](#json_api-routes-bulk_update-batch_size){: #json_api-routes-bulk_update-batch_size } | `pos_integer` | | The number of records to update per batch, passed through to `Ash.update_all/3`. |
| [`success_status`](#json_api-routes-bulk_update-success_status){: #json_api-routes-bulk_update-success_status } | `integer` | `200` | The HTTP status code to use when every record succeeds. |
| [`partial_success_status`](#json_api-routes-bulk_update-partial_success_status){: #json_api-routes-bulk_update-partial_success_status } | `integer` | `207` | The HTTP status code to use when some records succeed and some fail (per-record mode only). |
| [`read_action`](#json_api-routes-bulk_update-read_action){: #json_api-routes-bulk_update-read_action } | `atom` | | The read action to use to look the records up before updating |





### Introspection

Target: `AshJsonApi.Resource.Route`
Expand Down
Loading
Loading