Skip to content

Commit 986522f

Browse files
committed
RDoc-3274 - add a Studio refresh-feature page
1 parent 8bc50dd commit 986522f

File tree

17 files changed

+129
-4
lines changed

17 files changed

+129
-4
lines changed

Documentation/5.4/Raven.Documentation.Pages/studio/database/settings/.docs.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,12 @@
4141
"DiscussionId": "c5633531-4b5d-4816-97d4-82d351f3f6a2",
4242
"Mappings": []
4343
},
44+
{
45+
"Path": "document-refresh.markdown",
46+
"Name": "Document Refresh",
47+
"DiscussionId": "c5633531-4b5d-4816-97d4-82d351f3f6a2",
48+
"Mappings": []
49+
},
4450
{
4551
"Path": "manage-database-group.markdown",
4652
"Name": "Manage Database Group",

Documentation/5.4/Raven.Documentation.Pages/studio/database/settings/document-expiration.markdown

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33

44
{NOTE: }
55

6-
* Use this view to schedule documents an expiration time in which they will be deleted.
6+
* Use this view to configure the **Document Expiration** feature.
7+
* Documents can be scheduled for deletion by an `@expires` property in their `@metadata`.
8+
* When the document expiration feature is enabled, it routinely checks for documents that
9+
include the `@expires` property and deletes them on the scheduled time.
710
* Learn more about this option [here](../../../server/extensions/expiration).
811

912
{NOTE/}
@@ -12,7 +15,7 @@
1215

1316
{PANEL: Document Expiration View}
1417

15-
![Figure 1. Document Expiration View](images/document-expiration.png "Set Document Expiration")
18+
![Document Expiration View](images/document-expiration.png "Set Document Expiration")
1619

1720
1. **Document Expiration**
1821
Click to configure document expiration.
@@ -24,6 +27,8 @@
2427
Default value: _60 seconds_
2528
* **Set max number of documents to process in a single run**
2629
Set the maximal number of documents the feature is allowed to delete in one run.
30+
* **Save**
31+
Changes in the configuration will apply only after saving them.
2732

2833
3. **Set the `@expires` property inside the document that should be deleted**
2934
* Add the `@metadata` of each document whose expiration you want to schedule, an `@expires` property.
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Document Refresh
2+
---
3+
4+
{NOTE: }
5+
6+
* Use this view to configure the **Document Refresh** feature.
7+
* Documents can be scheduled for refresh by a `@refresh` property in their `@metadata`.
8+
* When the document refresh feature is enabled, it routinely checks for documents that
9+
include the `@refresh` property and refreshes them on the scheduled time.
10+
When a document is refreshed its [change vector](../../server/clustering/replication/change-vector)
11+
is incremented, triggering its re-indexation and other features that react to document updates.
12+
* Documents are refreshed only once: after refreshing a document, the refresh feature removes
13+
the `@refresh` property from its `@metadata`.
14+
* Learn more about this option [here](../../../server/extensions/refresh).
15+
16+
{NOTE/}
17+
18+
---
19+
20+
{PANEL: Document Refresh View}
21+
22+
![Document Refresh View](images/document-refresh.png "Document Refresh View")
23+
24+
1. **Document Refresh**
25+
Click to configure document refresh.
26+
27+
2. **Document Refresh Configuration**
28+
* **Enable Document Refresh**
29+
Toggle this option to enable or disable the refresh feature for the selected database.
30+
* **Set refresh frequency**
31+
Set the frequency at which the server scans for documents scheduled for refresh.
32+
Default value: _60 seconds_
33+
* **Set max number of documents to process in a single run**
34+
Set the maximal number of documents the feature is allowed to refresh in one run.
35+
* **Save**
36+
Changes in the configuration will apply only after saving them.
37+
38+
3. **Set the `@refresh` property**
39+
* Add a `@refresh` property to the `@metadata` of each document that you want to schedule refresh for.
40+
* Set the refresh time in UTC format, e.g. - `"@refresh": "2025-04-22T08:00:00.0000000Z"`
41+
42+
{PANEL/}
43+
44+
## Related Articles
45+
46+
- [Server: Documents Refresh](../../../server/extensions/refresh)
243 Bytes
Loading
226 KB
Loading

Documentation/6.0/Raven.Documentation.Pages/studio/database/settings/.docs.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,12 @@
4141
"DiscussionId": "c5633531-4b5d-4816-97d4-82d351f3f6a2",
4242
"Mappings": []
4343
},
44+
{
45+
"Path": "document-refresh.markdown",
46+
"Name": "Document Refresh",
47+
"DiscussionId": "c5633531-4b5d-4816-97d4-82d351f3f6a2",
48+
"Mappings": []
49+
},
4450
{
4551
"Path": "document-archival.markdown",
4652
"Name": "Document Archival",

Documentation/6.2/Raven.Documentation.Pages/studio/database/settings/.docs.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,12 @@
4141
"DiscussionId": "c5633531-4b5d-4816-97d4-82d351f3f6a2",
4242
"Mappings": []
4343
},
44+
{
45+
"Path": "document-refresh.markdown",
46+
"Name": "Document Refresh",
47+
"DiscussionId": "c5633531-4b5d-4816-97d4-82d351f3f6a2",
48+
"Mappings": []
49+
},
4450
{
4551
"Path": "document-archival.markdown",
4652
"Name": "Document Archival",

0 commit comments

Comments
 (0)