AshArchival.Resource.Info (ash_archival v1.1.1)
View SourceIntrospection helpers for AshArchival.Resource
Summary
Functions
A list of relationships that should have all related items archived when this is archived. Notifications are not sent for this operation.
A list of relationships that should have all related items archived when this is archived. Notifications are not sent for this operation.
A function to allow passing along some of the arguments to related resources when archiving them.
A function to allow passing along some of the arguments to related resources when archiving them.
The attribute in which to store the archival flag (the current datetime).
The attribute in which to store the archival flag (the current datetime).
The attribute type.
The attribute type.
Whether or not a base filter exists that applies the is_nil(archived_at)
rule.
A destroy action or actions that should not archive, but instead be left alone. This allows for having a destroy or archive pattern.
A destroy action or actions that should not archive, but instead be left alone. This allows for having a destroy or archive pattern.
A read action or actions that should show archived items. They will not get the automatic is_nil(archived_at)
filter.
A read action or actions that should show archived items. They will not get the automatic is_nil(archived_at)
filter.
This option is deprecated as it no longer has any effect. Upserts are handled according to the upsert identity. See the upserts guide for more.
This option is deprecated as it no longer has any effect. Upserts are handled according to the upsert identity. See the upserts guide for more.
archive DSL options
Functions
The attribute in which to store the archival flag (the current datetime).
The attribute in which to store the archival flag (the current datetime).
The attribute type.
The attribute type.
Whether or not a base filter exists that applies the is_nil(archived_at)
rule.
@spec archive_exclude_destroy_actions(dsl_or_extended :: module() | map()) :: {:ok, [atom()]} | :error
A destroy action or actions that should not archive, but instead be left alone. This allows for having a destroy or archive pattern.
@spec archive_exclude_destroy_actions!(dsl_or_extended :: module() | map()) :: [atom()] | no_return()
A destroy action or actions that should not archive, but instead be left alone. This allows for having a destroy or archive pattern.
A read action or actions that should show archived items. They will not get the automatic is_nil(archived_at)
filter.
A read action or actions that should show archived items. They will not get the automatic is_nil(archived_at)
filter.
@spec archive_exclude_upsert_actions(dsl_or_extended :: module() | map()) :: {:ok, [atom()]} | :error
This option is deprecated as it no longer has any effect. Upserts are handled according to the upsert identity. See the upserts guide for more.
@spec archive_exclude_upsert_actions!(dsl_or_extended :: module() | map()) :: [atom()] | no_return()
This option is deprecated as it no longer has any effect. Upserts are handled according to the upsert identity. See the upserts guide for more.
archive DSL options
Returns a map containing the and any configured or default values.