Skip to content

Commit 1e87290

Browse files
committed
RDoc-3375 Fix review comments
1 parent 1126d71 commit 1e87290

File tree

2 files changed

+12
-5
lines changed

2 files changed

+12
-5
lines changed

Documentation/6.2/Raven.Documentation.Pages/data-archival/schedule-document-archiving.dotnet.markdown

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,17 @@
44
{NOTE: }
55

66
* Documents cannot be archived directly - they must be scheduled for archival.
7-
To **schedule a document** for archival, add the `@archive-at` property to the document's metadata, and set its value to the desired archival time (in UTC).
7+
To **schedule a document** for archival, add the `@archive-at` property to the document's metadata and set its value to the desired archival time (in UTC).
88
This can be done in several ways, as described in this article.
99

10-
* When the archival feature is enabled, RavenDB runs a background archiving task that periodically scans the database for documents scheduled for archival.
11-
The scan frequency is configurable when [Enabling the archival feature](../data-archival/enable-data-archiving) (default: 60 seconds).
12-
10+
* **Note**:
11+
Just scheduling a document for archival does Not archive it at the specified time.
12+
Actual archiving is performed only by a background task that runs when the archival feature is [enabled](../data-archival/enable-data-archiving).
13+
This task periodically scans the database for documents scheduled for archival.
14+
The scan frequency is configurable when [enabling ](../data-archival/enable-data-archiving) the archival feature (default: 60 seconds).
15+
1316
* The archiving task will archive any document whose `@archive-at` time has passed at the time of the scan.
14-
The `@archive-at` metadata property will be replaced with `@archived: true`.
17+
The `@archive-at` metadata property will then be replaced with `@archived: true`.
1518

1619
* You can schedule documents for archival even if the archiving feature is not yet enabled.
1720
These documents will be archived once the feature is enabled and the task runs - provided the scheduled time has already passed.

Documentation/6.2/Raven.Documentation.Pages/data-archival/unarchiving-documents.dotnet.markdown

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@
99
* The archiving feature does Not need to be enabled to unarchive documents.
1010
Any previously archived document can be unarchived, regardless of the feature's current state.
1111

12+
* Do **not** attempt to unarchive a document by manually removing the `@archived: true` metadata property from the document.
13+
This will not clear the internal archived status of the document.
14+
To properly unarchive a document, use the `archived.unarchive()` method as described below.
15+
1216
* In this article:
1317
* [Unarchive documents - from the Client API](../data-archival/unarchiving-documents#unarchive-documents---from-the-client-api)
1418
* [Unarchive documents - from the Studio](../data-archival/unarchiving-documents#unarchive-documents---from-the-studio)

0 commit comments

Comments
 (0)