Skip to content

Commit 6cfd9f8

Browse files
ppekrolppekrol
authored
Merge pull request #2057 from Danielle9897/RDoc-3375-fixArchiveDocs
RDoc-3375 Data archival feature (C#)
2 parents 716e24e + 1e87290 commit 6cfd9f8

File tree

64 files changed

+1987
-40
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+1987
-40
lines changed

‎Documentation/6.0/Raven.Documentation.Pages/server/configuration/indexing-configuration.markdown

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -210,9 +210,12 @@ EXPERT ONLY:
210210

211211
{PANEL: Indexing.Auto.ArchivedDataProcessingBehavior}
212212

213-
Set the default deployment mode for static indexes.
213+
The default processing behavior for archived documents in auto-indexes.
214214

215-
- **Type**: `enum IndexDeploymentModeArchivedDataProcessingBehavior` (`ExcludeArchived`, `IncludeArchived`, `ArchivedOnly`)
215+
- **Type**: `enum ArchivedDataProcessingBehavior`:
216+
* `ExcludeArchived`: only non-archived documents are processed by the index.
217+
* `IncludeArchived`: both archived and non-archived documents are processed by the index.
218+
* `ArchivedOnly`: only archived documents are processed by the index.
216219
- **Default**: `ExcludeArchived`
217220
- **Scope**: Server-wide, or per database
218221

@@ -351,9 +354,16 @@ Allow to open an index without checking if current Database ID matched the one f
351354

352355
{PANEL: Indexing.Static.ArchivedDataProcessingBehavior}
353356

354-
Set the default deployment mode for static indexes.
357+
* Set the default processing behavior for archived documents in static indexes.
358+
* This setting applies only to static indexes that use _Documents_ as their data source.
359+
It does not apply to indexes based on _Time Series_ or _Counters_, which default to `IncludeArchived`.
360+
361+
---
355362

356-
- **Type**: `enum IndexDeploymentModeArchivedDataProcessingBehavior` (`ExcludeArchived`, `IncludeArchived`, `ArchivedOnly`)
363+
- **Type**: `enum ArchivedDataProcessingBehavior`:
364+
* `ExcludeArchived`: only non-archived documents are processed by the index.
365+
* `IncludeArchived`: both archived and non-archived documents are processed by the index.
366+
* `ArchivedOnly`: only archived documents are processed by the index.
357367
- **Default**: `ExcludeArchived`
358368
- **Scope**: Server-wide, or per database
359369

‎Documentation/6.0/Raven.Documentation.Pages/server/extensions/.docs.json

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,12 @@
2020
"Path": "archival.markdown",
2121
"Name": "Data Archival",
2222
"DiscussionId": "b976732a-3da7-48e5-a454-4f34b8f716f9",
23-
"Mappings": []
23+
"Mappings": [
24+
{
25+
"Version": 6.2,
26+
"Key": "data-archival/overview"
27+
}
28+
],
29+
"LastSupportedVersion": "6.0"
2430
}
2531
]

‎Documentation/6.0/Raven.Documentation.Pages/server/kb/javascript-engine.markdown

Lines changed: 160 additions & 0 deletions
Large diffs are not rendered by default.

‎Documentation/6.2/Raven.Documentation.Pages/.docs.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,11 @@
1919
"Name": "Document Extensions",
2020
"Mappings": []
2121
},
22+
{
23+
"Path": "/data-archival",
24+
"Name": "Data Archival",
25+
"Mappings": []
26+
},
2227
{
2328
"Path": "/server",
2429
"Name": "Server",

‎Documentation/6.2/Raven.Documentation.Pages/client-api/operations/server-wide/create-database.dotnet.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ The `DatabaseRecord` is a collection of database configurations:
108108
| **AutoIndexes** | `Dictionary<string, AutoIndexDefinition>` | Auto-index definitions for the database. |
109109
| **Client** | `ClientConfiguration` | [Client behavior](../../../studio/server/client-configuration) configuration. |
110110
| **ConflictSolverConfig** | `ConflictSolver` | Define the strategy used to resolve [Replication conflicts](../../../server/clustering/replication/replication-conflicts). |
111-
| **DataArchival** | `DataArchivalConfiguration` | [Data Archival](../../../server/extensions/archival) configuration for the database. |
111+
| **DataArchival** | `DataArchivalConfiguration` | [Data Archival](../../../data-archival/overview) configuration for the database. |
112112
| **DatabaseName** | `string` | The database name. |
113113
| **Disabled** | `bool` | Set the database initial state.<br> `true` - disable the database.<br> `false` - (default) the database will be enabled.<br><br>This can be modified later via [ToggleDatabasesStateOperation](../../../client-api/operations/server-wide/toggle-databases-state). |
114114
| **DocumentsCompression** | `DocumentsCompressionConfiguration` | Configuration settings for [Compressing documents](../../../server/storage/documents-compression). |

‎Documentation/6.2/Raven.Documentation.Pages/client-api/operations/server-wide/create-database.java.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@
7676
| **autoIndexes** | `Map<String, AutoIndexDefinition>` | Auto-index definitions for the database. |
7777
| **client** | `ClientConfiguration` | [Client behavior](../../../studio/server/client-configuration) configuration. |
7878
| **conflictSolverConfig** | `ConflictSolver` | Define the strategy used to resolve [Replication conflicts](../../../server/clustering/replication/replication-conflicts). |
79-
| **dataArchival** | `DataArchivalConfiguration` | [Data Archival](../../../server/extensions/archival) configuration for the database. |
79+
| **dataArchival** | `DataArchivalConfiguration` | [Data Archival](../../../data-archival/overview) configuration for the database. |
8080
| **databaseName** | `String` | The database name. |
8181
| **disabled** | `boolean` (default: false) | Set the database initial state.<br> `true` - disable the database.<br> `false` - (default) the database will be enabled.<br><br>This can be modified later via [ToggleDatabasesStateOperation](../../../client-api/operations/server-wide/toggle-databases-state). |
8282
| **documentsCompression** | `DocumentsCompressionConfiguration` | Configuration settings for [Compressing documents](../../../server/storage/documents-compression). |

‎Documentation/6.2/Raven.Documentation.Pages/client-api/operations/what-are-operations.dotnet.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,7 @@
270270
* **Misc**:
271271
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ConfigureExpirationOperation
272272
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ConfigureRefreshOperation
273+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [ConfigureDataArchivalOperation](../../data-archival/enable-data-archiving#enable-archiving---from-the-client-api)
273274
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; UpdateDocumentsCompressionConfigurationOperation
274275
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; DatabaseHealthCheckOperation
275276
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; GetOperationStateOperation

‎Documentation/6.2/Raven.Documentation.Pages/client-api/operations/what-are-operations.js.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,7 @@ __Send syntax__:
271271
* __Misc__:
272272
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ConfigureExpirationOperation
273273
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ConfigureRefreshOperation
274+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ConfigureDataArchivalOperation
274275
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; UpdateDocumentsCompressionConfigurationOperation
275276
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; DatabaseHealthCheckOperation
276277
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; GetOperationStateOperation

‎Documentation/6.2/Raven.Documentation.Pages/client-api/operations/what-are-operations.php.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -256,6 +256,7 @@
256256
* **Misc**:
257257
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ConfigureExpirationOperation
258258
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ConfigureRefreshOperation
259+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ConfigureDataArchivalOperation
259260
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; UpdateDocumentsCompressionConfigurationOperation
260261
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; DatabaseHealthCheckOperation
261262
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; GetOperationStateOperation

‎Documentation/6.2/Raven.Documentation.Pages/client-api/operations/what-are-operations.python.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,7 @@
257257
* **Misc**:
258258
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ConfigureExpirationOperation
259259
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ConfigureRefreshOperation
260+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ConfigureDataArchivalOperation
260261
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; UpdateDocumentsCompressionConfigurationOperation
261262
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; DatabaseHealthCheckOperation
262263
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; GetOperationStateOperation

0 commit comments

Comments
 (0)