Skip to main content

Data archival configuration

For an overview of what configuration options are and how they can be applied,
see the Configuration Overview article.
The following configuration options are available for data archival:

Indexing.Static.ArchivedDataProcessingBehavior

Set the default processing behavior for archived documents in static indexes.
This setting applies only to static indexes that use Documents as their data source.
It does not apply to indexes based on Time Series or Counters, which default to IncludeArchived.

Type: enum ArchivedDataProcessingBehavior:
- ExcludeArchived: only non-archived documents are processed by the index.
- IncludeArchived: both archived and non-archived documents are processed by the index.
- ArchivedOnly: only archived documents are processed by the index.
Default: ExcludeArchived
Scope: Server-wide, or per database

Indexing.Auto.ArchivedDataProcessingBehavior

The default processing behavior for archived documents in auto-indexes.

Type: enum ArchivedDataProcessingBehavior:
- ExcludeArchived: only non-archived documents are processed by the index.
- IncludeArchived: both archived and non-archived documents are processed by the index.
- ArchivedOnly: only archived documents are processed by the index.
Default: ExcludeArchived
Scope: Server-wide, or per database

Subscriptions.ArchivedDataProcessingBehavior

The default processing behavior for archived documents in a subscription query.

Type: enum ArchivedDataProcessingBehavior:
- ExcludeArchived: only non-archived documents are processed by the subscription query.
- IncludeArchived: both archived and non-archived documents are processed by the subscription query.
- ArchivedOnly: only archived documents are processed by the subscription query.
Default: ExcludeArchived
Scope: Server-wide, or per database

In this article