Document Archival

Data Archival View

1. Click to open the settings view.

2. Click to open the Data Archival view.

3. Toggle to enable archiving on this ("sampleDB") database.

4. Toggle (available only when option #3 above is enabled) to provide the frequency by which RavenDB's archiving task scans the database for documents that need to be archived.
   Default frequency: 60 seconds
   

5. Click to apply your settings.

6. Click for help using this view.

7. Click for Licensing info.

To schedule a document's archival time open the document view and edit the document you want to archive.

Document View: @archive-at Property

1. Add this property to the document's metadata.
2. Provide the archival time (UTC time) as a value (see an example here).
3. After adding the @archive-at property, the time that remains until the document is archived is displayed here.

Document View: @archived Property

1. The document is archived.
   RavenDB replaced the @archive-at flag with an @archived flag, indicating that the document is now archived.

2. Studio recognizes that the document is archived.

Documents List: Archived Icon

An icon was added to the icons list so archived documents can be recognized at a glance.

Open the Database Settings view to set feature-specific archiving settings.
This is where different features, currently indexing and data subscriptions, are taught how to handle archived documents.

Database Settings: Feature-Specific Archival Configuration

1. Click to enter text
   Type "Archive" to list configuration options related to archiving.
   The three related options are:
   Auto Indexing Handling of Archived Documents
   Static Indexing Handling of Archived Documents
   Data Subscriptions Handling of Archived Documents

2. Click to configure
   

   Please edit configuration options only if you're sure you understand them.
   

Database Settings: Edit Configuration

1. Click a feature-specific configuration option to edit its settings.
2. Toggle to override the current configuration.
3. Select one of the three options.
   • ExcludeArchived
     DO not process archived documents
   • IncludeArchived
     Process archived documents
   • ArchivedOnly Process ONLY archived documents
4. Save your configuration.

To set the way a specific index handles archived documents (overriding default server/database configuration), open the Index List view and select the index whose behavior you want to set, scroll down for the index properties and open the Archived Data tab.

Index Definition Archived Data Tab

1. Click to open the Archived Data tab.

2. Click to determine how this index would handle archived documents.

   

   Archived Docs Handling Options

   Select how this index handles archived documents.
   Default - Do not change the policy set by higher (database/server) configuration levels.
   Exclude Archived - Do not process archived documents (this is the default configuration).
   Include Archived - Process archived documents.
   Archived Only - Process only archived documents.

To set the way a specific data subscription task handles archived documents (overriding default server/database configuration), open the Subscription Task view and create a new subscription.

Subscription Archived Data Processing Behavior

1. Click to select how this subscription handles archived documents.

   

   Archived Docs Handling Options

   Default - Do not change the policy set by higher (database/server) configuration levels.
   Exclude Archived - Do not process archived documents (this is the default configuration).
   Include Archived - Process archived documents.
   Archived Only - Process only archived documents.

To determine whether a data-export task would export archived documents, enter the task's configuration (by creating a new task or editing an existing one) and toggle the Include Archived Documents option as preferred.

Data Export Option

To determine whether a data-import task would import archived documents, enter the task's configuration (by creating a new task or editing an existing one) and toggle the Include Archived Documents option as you prefer.

Data Import Option