View Source AshArchival.Resource.Info (ash_archival v1.0.2)

Introspection 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.

The attribute in which to store the archival flag (the current datetime).

The attribute in which to store the archival flag (the current datetime).

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.

archive DSL options

Functions

Link to this function

archive_archive_related(dsl_or_extended)

View Source
@spec archive_archive_related(dsl_or_extended :: module() | map()) ::
  {:ok, [atom()]} | :error

A list of relationships that should have all related items archived when this is archived. Notifications are not sent for this operation.

Link to this function

archive_archive_related!(dsl_or_extended)

View Source
@spec archive_archive_related!(dsl_or_extended :: module() | map()) ::
  [atom()] | no_return()

A list of relationships that should have all related items archived when this is archived. Notifications are not sent for this operation.

Link to this function

archive_attribute(dsl_or_extended)

View Source
@spec archive_attribute(dsl_or_extended :: module() | map()) :: {:ok, atom()} | :error

The attribute in which to store the archival flag (the current datetime).

Link to this function

archive_attribute!(dsl_or_extended)

View Source
@spec archive_attribute!(dsl_or_extended :: module() | map()) :: atom() | no_return()

The attribute in which to store the archival flag (the current datetime).

Link to this function

archive_base_filter?(dsl_or_extended)

View Source
@spec archive_base_filter?(dsl_or_extended :: module() | map()) :: atom()

Whether or not a base filter exists that applies the is_nil(archived_at) rule.

Link to this function

archive_exclude_destroy_actions(dsl_or_extended)

View Source
@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.

Link to this function

archive_exclude_destroy_actions!(dsl_or_extended)

View Source
@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.

Link to this function

archive_exclude_read_actions(dsl_or_extended)

View Source
@spec archive_exclude_read_actions(dsl_or_extended :: module() | map()) ::
  {:ok, [atom()]} | :error

A read action or actions that should show archived items. They will not get the automatic is_nil(archived_at) filter.

Link to this function

archive_exclude_read_actions!(dsl_or_extended)

View Source
@spec archive_exclude_read_actions!(dsl_or_extended :: module() | map()) ::
  [atom()] | no_return()

A read action or actions that should show archived items. They will not get the automatic is_nil(archived_at) filter.

Link to this function

archive_options(dsl_or_extended)

View Source
@spec archive_options(dsl_or_extended :: module() | map()) :: %{
  required(atom()) => any()
}

archive DSL options

Returns a map containing the and any configured or default values.