Ash.Resource.Interface (ash v3.4.56)
View SourceRepresents a function in a resource's code interface
See the functions defined in this module for specifications of the options that each type of code interface function supports in its options list.
Summary
Functions
Options supported by code interfaces for calculations
Options supported by code interfaces for create actions
Options supported by code interfaces for destroy actions
Options supported by code interfaces for generic actions
Options supported by code interfaces for read actions with get?
or get_by
set.
Options supported by code interfaces for read actions
Options supported by code interfaces for update actions
Types
Functions
Options supported by code interfaces for calculations
Options
:actor
(term/0
) - The actor for handling^actor/1
templates, supplied to calculation context.:tenant
(value that implements theAsh.ToTenant
protocol) - The tenant, supplied to calculation context.:authorize?
(boolean/0
) - Whether or not the request is being authorized, provided to calculation context. The default value istrue
.:tracer
(one or a list of module that adoptsAsh.Tracer
) - A tracer, provided to the calculation context.:data_layer?
(boolean/0
) - Set totrue
to require that the value be computed within the data layer. Only works for calculations that define an expression.
Options supported by code interfaces for create actions
Options
:upsert?
(boolean/0
) - If a conflict is found based on the primary key, the record is updated in the database (requires upsert support) The default value isfalse
.:return_skipped_upsert?
(boolean/0
) - Iftrue
, and a record was not upserted because its filter prevented the upsert, the original record (which was not upserted) will be returned. The default value isfalse
.:upsert_identity
(atom/0
) - The identity to use when detecting conflicts forupsert?
, e.g.upsert_identity: :full_name
. By default, the primary key is used. Has no effect ifupsert?: true
is not provided:upsert_fields
- The fields to upsert. If not set, the action's upsert_fields is used, and if that is not set, then any fields not being set to defaults are written.:upsert_condition
(term/0
) - An expression to check if the record should be updated when there's a conflict.:timeout
(timeout/0
) - A positive integer, or:infinity
. If none is provided, the timeout configured on the domain is used.:tracer
(one or a list of module that adoptsAsh.Tracer
) - A tracer that implements theAsh.Tracer
behaviour. See that module for more.:action
(term/0
) - The action to use, either an Action struct or the name of the action:authorize?
- If an actor option is provided (even if it isnil
), authorization happens automatically. If not, this flag can be used to authorize with no user. Valid values are true, false, nil:context
(map/0
) - Context to set on the query, changeset, or input:tenant
(value that implements theAsh.ToTenant
protocol) - A tenant to set on the query or changeset:actor
(term/0
) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:return_notifications?
(boolean/0
) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}
(or{:ok, notifications}
)
To send notifications later, useAsh.Notifier.notify(notifications)
. It sends any notifications that can be sent, and returns the rest. The default value isfalse
.:rollback_on_error?
(boolean/0
) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? false
this option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue
.:notification_metadata
(term/0
) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}
.:skip_unknown_inputs
- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*
to indicate all unknown keys.:load
(term/0
) - A load statement to add onto the changeset:changeset
(term/0
) - A changeset to seed the action with.:bulk_options
(keyword/0
) - Options passed toAsh.bulk_create
, if a list or stream of inputs is provided.:select
(list ofatom/0
) - A select statement to apply to records. Ignored ifreturn_records?
is not true.:after_action
(function of arity 2) - An after_action hook to be added to each processed changeset:read_action
(atom/0
) - The action to use when building the read query.:assume_casted?
(boolean/0
) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse
.:select
(list ofatom/0
) - A select statement to apply to records. Ignored ifreturn_records?
is not true.:authorize_query_with
- If set to:error
, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_with
if not set.:authorize_changeset_with
- If set to:error
, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_with
if not set.:authorize_with
- If set to:error
, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter
.:sorted?
(boolean/0
) - Whether or not to sort results by their input position, in cases wherereturn_records?: true
was provided. The default value isfalse
.:return_records?
(boolean/0
) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse
.:return_errors?
(boolean/0
) - Whether or not to return all of the errors that occur. Defaults to false to account for large inserts. The default value isfalse
.:batch_size
(pos_integer/0
) - The number of records to include in each batch. Defaults to thedefault_limit
ormax_page_size
of the action, or 100.:return_stream?
(boolean/0
) - If set totrue
, instead of anAsh.BulkResult
, a mixed stream is returned.Potential elements:
{:notification, notification}
- ifreturn_notifications?
is set totrue
{:ok, record}
- ifreturn_records?
is set totrue
{:error, error}
- an error that occurred. May be changeset or an invidual error.The default value is
false
.:return_nothing?
(boolean/0
) - Mutes warnings about returning nothing.Only relevant if
return_stream?
is set totrue
and all otherreturn_*?
options are set tofalse
.The default value is
false
.:stop_on_error?
(boolean/0
) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse
.:notify?
(boolean/0
) - Whether or not to generate any notifications. If this is set totrue
then the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?
is set totrue
.The default value is
false
.:transaction
- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transaction
andafter_transaction
hooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all
.The default value is
:batch
.:max_concurrency
(non_neg_integer/0
) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0
.
Options supported by code interfaces for destroy actions
Options
:return_destroyed?
(boolean/0
) - If true, the destroyed record is included in the return result, e.g{:ok, destroyed}
or{:ok, destroyed, notifications}
The default value isfalse
.:timeout
(timeout/0
) - A positive integer, or:infinity
. If none is provided, the timeout configured on the domain is used.:tracer
(one or a list of module that adoptsAsh.Tracer
) - A tracer that implements theAsh.Tracer
behaviour. See that module for more.:action
(term/0
) - The action to use, either an Action struct or the name of the action:authorize?
- If an actor option is provided (even if it isnil
), authorization happens automatically. If not, this flag can be used to authorize with no user. Valid values are true, false, nil:context
(map/0
) - Context to set on the query, changeset, or input:tenant
(value that implements theAsh.ToTenant
protocol) - A tenant to set on the query or changeset:actor
(term/0
) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:return_notifications?
(boolean/0
) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}
(or{:ok, notifications}
)
To send notifications later, useAsh.Notifier.notify(notifications)
. It sends any notifications that can be sent, and returns the rest. The default value isfalse
.:rollback_on_error?
(boolean/0
) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? false
this option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue
.:notification_metadata
(term/0
) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}
.:skip_unknown_inputs
- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*
to indicate all unknown keys.:load
(term/0
) - A load statement to add onto the changeset:bulk_options
(keyword/0
) - Options passed toAsh.bulk_create
, if a query, list, or stream of inputs is provided.:stream_batch_size
(integer/0
) - Batch size to use if provided a query and the query must be streamed:allow_stream_with
- The 'worst' strategy allowed to be used to fetch records if the:stream
strategy is chosen. See theAsh.stream!/2
docs for more. The default value is:keyset
.:authorize_query?
(boolean/0
) - If a query is given, determines whether or not authorization is run on that query. The default value istrue
.:strategy
- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is:atomic
.:filter
(term/0
) - A filter to apply to records. This is also applied to a stream of inputs.:allow_stream_with
- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2
docs for more. The default value is:keyset
.:stream_with
- The specific strategy to use to fetch records. SeeAsh.stream!/2
docs for more.:max_concurrency
(non_neg_integer/0
) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2
:lock
(term/0
) - A lock statement to add onto the query:return_query?
(boolean/0
) - Iftrue
, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false
.:reuse_values?
(boolean/0
) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse
.:strict?
(boolean/0
) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2
.The default value is
false
.:authorize_with
- If set to:error
, instead of applying authorization filters as a filter, any records not matching the authroization filter will cause an error to be returned. The default value is:filter
.:read_action
(atom/0
) - The action to use when building the read query.:assume_casted?
(boolean/0
) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse
.:select
(list ofatom/0
) - A select statement to apply to records. Ignored ifreturn_records?
is not true.:authorize_query_with
- If set to:error
, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_with
if not set.:authorize_changeset_with
- If set to:error
, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_with
if not set.:authorize_with
- If set to:error
, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter
.:sorted?
(boolean/0
) - Whether or not to sort results by their input position, in cases wherereturn_records?: true
was provided. The default value isfalse
.:return_records?
(boolean/0
) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse
.:return_errors?
(boolean/0
) - Whether or not to return all of the errors that occur. Defaults to false to account for large inserts. The default value isfalse
.:batch_size
(pos_integer/0
) - The number of records to include in each batch. Defaults to thedefault_limit
ormax_page_size
of the action, or 100.:return_stream?
(boolean/0
) - If set totrue
, instead of anAsh.BulkResult
, a mixed stream is returned.Potential elements:
{:notification, notification}
- ifreturn_notifications?
is set totrue
{:ok, record}
- ifreturn_records?
is set totrue
{:error, error}
- an error that occurred. May be changeset or an invidual error.The default value is
false
.:return_nothing?
(boolean/0
) - Mutes warnings about returning nothing.Only relevant if
return_stream?
is set totrue
and all otherreturn_*?
options are set tofalse
.The default value is
false
.:stop_on_error?
(boolean/0
) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse
.:notify?
(boolean/0
) - Whether or not to generate any notifications. If this is set totrue
then the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?
is set totrue
.The default value is
false
.:transaction
- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transaction
andafter_transaction
hooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all
.The default value is
:batch
.:max_concurrency
(non_neg_integer/0
) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0
.
Options supported by code interfaces for generic actions
Options
:actor
(term/0
) - The actor for handling^actor/1
templates, supplied to calculation context.:tenant
(value that implements theAsh.ToTenant
protocol) - The tenant, supplied to calculation context.:authorize?
(boolean/0
) - Whether or not the request should be authorized.:tracer
(one or a list of module that adoptsAsh.Tracer
) - A tracer, provided to the calculation context.:skip_unknown_inputs
- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*
to indicate all unknown keys.
Options supported by code interfaces for read actions with get?
or get_by
set.
Options
:page
- Pagination options, seeAsh.read/2
for more.:load
(term/0
) - A load statement to add onto the query:max_concurrency
(non_neg_integer/0
) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2
:lock
(term/0
) - A lock statement to add onto the query:return_query?
(boolean/0
) - Iftrue
, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse
.:skip_unknown_inputs
- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*
to indicate all unknown keys.:reuse_values?
(boolean/0
) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse
.:strict?
(boolean/0
) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2
. The default value isfalse
.:authorize_with
- If set to:error
, instead of applying authorization filters as a filter, any records not matching the authroization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter
.:timeout
(timeout/0
) - A positive integer, or:infinity
. If none is provided, the timeout configured on the domain is used.:tracer
(one or a list of module that adoptsAsh.Tracer
) - A tracer that implements theAsh.Tracer
behaviour. See that module for more.:action
(term/0
) - The action to use, either an Action struct or the name of the action:authorize?
- If an actor option is provided (even if it isnil
), authorization happens automatically. If not, this flag can be used to authorize with no user. Valid values are true, false, nil:context
(map/0
) - Context to set on the query, changeset, or input:tenant
(value that implements theAsh.ToTenant
protocol) - A tenant to set on the query or changeset:actor
(term/0
) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:query
- A query to seed the action with.:not_found_error?
(boolean/0
) - Whether or not to return or raise aNotFound
error or to returnnil
when a get? action/interface is called.:stream?
(boolean/0
) - If true, a stream of the results will be returned The default value isfalse
.:stream_options
(keyword/0
) - Options passed toAsh.stream!
, ifstream?: true
is given:batch_size
(integer/0
) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with
- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2
docs for more. The default value is:keyset
.:stream_with
- The specific strategy to use to fetch records. SeeAsh.stream!/2
docs for more.
Options supported by code interfaces for read actions
Options
:page
- Pagination options, seeAsh.read/2
for more.:load
(term/0
) - A load statement to add onto the query:max_concurrency
(non_neg_integer/0
) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2
:lock
(term/0
) - A lock statement to add onto the query:return_query?
(boolean/0
) - Iftrue
, the query that was ultimately used is returned as a third tuple element.
The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer. The default value isfalse
.:skip_unknown_inputs
- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*
to indicate all unknown keys.:reuse_values?
(boolean/0
) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse
.:strict?
(boolean/0
) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.
SeeAsh.Query.load/2
. The default value isfalse
.:authorize_with
- If set to:error
, instead of applying authorization filters as a filter, any records not matching the authroization filter will cause an error to be returned. Valid values are :filter, :error The default value is:filter
.:timeout
(timeout/0
) - A positive integer, or:infinity
. If none is provided, the timeout configured on the domain is used.:tracer
(one or a list of module that adoptsAsh.Tracer
) - A tracer that implements theAsh.Tracer
behaviour. See that module for more.:action
(term/0
) - The action to use, either an Action struct or the name of the action:authorize?
- If an actor option is provided (even if it isnil
), authorization happens automatically. If not, this flag can be used to authorize with no user. Valid values are true, false, nil:context
(map/0
) - Context to set on the query, changeset, or input:tenant
(value that implements theAsh.ToTenant
protocol) - A tenant to set on the query or changeset:actor
(term/0
) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:query
- A query to seed the action with.:not_found_error?
(boolean/0
) - Whether or not to return or raise aNotFound
error or to returnnil
when a get? action/interface is called.:stream?
(boolean/0
) - If true, a stream of the results will be returned The default value isfalse
.:stream_options
(keyword/0
) - Options passed toAsh.stream!
, ifstream?: true
is given:batch_size
(integer/0
) - How many records to request in each query run. Defaults to the pagination limits on the resource, or 250.:allow_stream_with
- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2
docs for more. The default value is:keyset
.:stream_with
- The specific strategy to use to fetch records. SeeAsh.stream!/2
docs for more.
Options supported by code interfaces for update actions
Options
:params
(map/0
) - Parameters to supply, ignored if the input is a changeset, only used when an identifier is given.:atomic_upgrade?
(boolean/0
) - If true the action will be done atomically if it can (and is configured to do so), ignoring the in memory transformations and validations. You should not generally need to disable this. The default value istrue
.:timeout
(timeout/0
) - A positive integer, or:infinity
. If none is provided, the timeout configured on the domain is used.:tracer
(one or a list of module that adoptsAsh.Tracer
) - A tracer that implements theAsh.Tracer
behaviour. See that module for more.:action
(term/0
) - The action to use, either an Action struct or the name of the action:authorize?
- If an actor option is provided (even if it isnil
), authorization happens automatically. If not, this flag can be used to authorize with no user. Valid values are true, false, nil:context
(map/0
) - Context to set on the query, changeset, or input:tenant
(value that implements theAsh.ToTenant
protocol) - A tenant to set on the query or changeset:actor
(term/0
) - If an actor is provided, it will be used in conjunction with the authorizers of a resource to authorize access:return_notifications?
(boolean/0
) - Use this if you're running ash actions in your own transaction and you want to manually handle sending notifications.
If a transaction is ongoing, and this is false, notifications will be discarded, otherwise the return value is{:ok, result, notifications}
(or{:ok, notifications}
)
To send notifications later, useAsh.Notifier.notify(notifications)
. It sends any notifications that can be sent, and returns the rest. The default value isfalse
.:rollback_on_error?
(boolean/0
) - Whether or not to rollback the transaction on error, if the resource is in a transaction.
If the action hastransaction? false
this option has no effect. If an error is returned from the data layer and the resource is in a transaction, the transaction is always rolled back, regardless. The default value istrue
.:notification_metadata
(term/0
) - Metadata to be merged into the metadata field for all notifications sent from this operation. The default value is%{}
.:skip_unknown_inputs
- A list of inputs that, if provided, will be ignored if they are not recognized by the action. Use:*
to indicate all unknown keys.:load
(term/0
) - A load statement to add onto the changeset:bulk_options
(keyword/0
) - Options passed toAsh.bulk_create
, if a query, list, or stream of inputs is provided.:atomic_update
(map/0
) - A map of atomic updates to apply. SeeAsh.Changeset.atomic_update/3
for more.:stream_batch_size
(integer/0
) - Batch size to use if provided a query and the query must be streamed:allow_stream_with
- The 'worst' strategy allowed to be used to fetch records if the:stream
strategy is chosen. See theAsh.stream!/2
docs for more. The default value is:keyset
.:authorize_query?
(boolean/0
) - If a query is given, determines whether or not authorization is run on that query. The default value istrue
.:select
(list ofatom/0
) - A select statement to apply to records. Ignored ifreturn_records?
is not true.:filter
(term/0
) - A filter to apply to records. This is also applied to a stream of inputs.:strategy
- The strategy or strategies to enable. :stream is used in all cases if the data layer does not support atomics. The default value is[:atomic]
.:allow_stream_with
- The 'worst' strategy allowed to be used to fetch records. SeeAsh.stream!/2
docs for more. The default value is:keyset
.:stream_with
- The specific strategy to use to fetch records. SeeAsh.stream!/2
docs for more.:max_concurrency
(non_neg_integer/0
) - The maximum number of processes allowed to be started for parallel loading of relationships and calculations. Defaults toSystem.schedulers_online() * 2
:lock
(term/0
) - A lock statement to add onto the query:return_query?
(boolean/0
) - Iftrue
, the query that was ultimately used is returned as a third tuple element.The query goes through many potential changes during a request, potentially adding authorization filters, or replacing relationships for other data layers with their corresponding ids. This option can be used to get the true query that was sent to the data layer.
The default value is
false
.:reuse_values?
(boolean/0
) - Whether calculations are allowed to reuse values that have already been loaded, or must refetch them from the data layer. The default value isfalse
.:strict?
(boolean/0
) - If set to true, only specified attributes will be loaded when passing a list of fields to fetch on a relationship, which allows for more optimized data-fetching.See
Ash.Query.load/2
.The default value is
false
.:authorize_with
- If set to:error
, instead of applying authorization filters as a filter, any records not matching the authroization filter will cause an error to be returned. The default value is:filter
.:read_action
(atom/0
) - The action to use when building the read query.:assume_casted?
(boolean/0
) - Whether or not to cast attributes and arguments as input. This is an optimization for cases where the input is already casted and/or not in need of casting The default value isfalse
.:select
(list ofatom/0
) - A select statement to apply to records. Ignored ifreturn_records?
is not true.:authorize_query_with
- If set to:error
, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. Usesauthorize_with
if not set.:authorize_changeset_with
- If set to:error
, instead of filtering unauthorized changes, unauthorized changes will raise an appropriate forbidden error. Usesauthorize_with
if not set.:authorize_with
- If set to:error
, instead of filtering unauthorized query results, unauthorized query results will raise an appropriate forbidden error. The default value is:filter
.:sorted?
(boolean/0
) - Whether or not to sort results by their input position, in cases wherereturn_records?: true
was provided. The default value isfalse
.:return_records?
(boolean/0
) - Whether or not to return all of the records that were inserted. Defaults to false to account for large inserts. The default value isfalse
.:return_errors?
(boolean/0
) - Whether or not to return all of the errors that occur. Defaults to false to account for large inserts. The default value isfalse
.:batch_size
(pos_integer/0
) - The number of records to include in each batch. Defaults to thedefault_limit
ormax_page_size
of the action, or 100.:return_stream?
(boolean/0
) - If set totrue
, instead of anAsh.BulkResult
, a mixed stream is returned.Potential elements:
{:notification, notification}
- ifreturn_notifications?
is set totrue
{:ok, record}
- ifreturn_records?
is set totrue
{:error, error}
- an error that occurred. May be changeset or an invidual error.The default value is
false
.:return_nothing?
(boolean/0
) - Mutes warnings about returning nothing.Only relevant if
return_stream?
is set totrue
and all otherreturn_*?
options are set tofalse
.The default value is
false
.:stop_on_error?
(boolean/0
) - If true, the first encountered error will stop the action and be returned. Otherwise, errors will be skipped. The default value isfalse
.:notify?
(boolean/0
) - Whether or not to generate any notifications. If this is set totrue
then the data layer must return the results from each batch. This may be intensive for large bulk actions.Notifications will be automatically sent unless
return_notifications?
is set totrue
.The default value is
false
.:transaction
- Whether or not to wrap the entire execution in a transaction, each batch, or not at all.Keep in mind:
before_transaction
andafter_transaction
hooks attached to changesets will have to be run inside the transaction if you choosetransaction: :all
.The default value is
:batch
.:max_concurrency
(non_neg_integer/0
) - If set to a value greater than 0, up to that many tasks will be started to run batches asynchronously The default value is0
.