mirror of https://github.com/ash-project/ash_archival.git synced 2024-09-21 05:52:56 +12:00

Zach Daniel f8e405c34f improvement: deprecate exclude_upsert_actions, as it had unintended side effects

docs: document how to handle upserts & identities with `ash_archival`

2024-08-16 11:30:57 -04:00

DSL: AshArchival.Resource

Configures a resource to be archived instead of destroyed for all destroy actions.

For more information, see the getting started guide

archive

A section for configuring how archival is configured for a resource.

Name	Type	Default	Docs
`attribute`{: #archive-attribute }	`atom`	`:archived_at`	The attribute in which to store the archival flag (the current datetime).
`base_filter?`{: #archive-base_filter? }	`atom`	`false`	Whether or not a base filter exists that applies the `is_nil(archived_at)` rule.
`exclude_read_actions`{: #archive-exclude_read_actions }	`atom \| list(atom)`	`[]`	A read action or actions that should show archived items. They will not get the automatic `is_nil(archived_at)` filter.
`exclude_upsert_actions`{: #archive-exclude_upsert_actions }	`atom \| list(atom)`	`[]`	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.
`exclude_destroy_actions`{: #archive-exclude_destroy_actions }	`atom \| list(atom)`	`[]`	A destroy action or actions that should not archive, but instead be left alone. This allows for having a destroy or archive pattern.
`archive_related`{: #archive-archive_related }	`list(atom)`	`[]`	A list of relationships that should have all related items archived when this is archived. Notifications are not sent for this operation.