Skip to content

RDoc-3375 Data archival feature (C#) #2057

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -210,9 +210,12 @@ EXPERT ONLY:

{PANEL: Indexing.Auto.ArchivedDataProcessingBehavior}

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

- **Type**: `enum IndexDeploymentModeArchivedDataProcessingBehavior` (`ExcludeArchived`, `IncludeArchived`, `ArchivedOnly`)
- **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

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

{PANEL: Indexing.Static.ArchivedDataProcessingBehavior}

Set the default deployment mode for static indexes.
* 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 IndexDeploymentModeArchivedDataProcessingBehavior` (`ExcludeArchived`, `IncludeArchived`, `ArchivedOnly`)
- **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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@
"Path": "archival.markdown",
"Name": "Data Archival",
"DiscussionId": "b976732a-3da7-48e5-a454-4f34b8f716f9",
"Mappings": []
"Mappings": [
{
"Version": 6.2,
"Key": "data-archival/overview"
}
],
"LastSupportedVersion": "6.0"
}
]

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions Documentation/6.2/Raven.Documentation.Pages/.docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@
"Name": "Document Extensions",
"Mappings": []
},
{
"Path": "/data-archival",
"Name": "Data Archival",
"Mappings": []
},
{
"Path": "/server",
"Name": "Server",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ The `DatabaseRecord` is a collection of database configurations:
| **AutoIndexes** | `Dictionary<string, AutoIndexDefinition>` | Auto-index definitions for the database. |
| **Client** | `ClientConfiguration` | [Client behavior](../../../studio/server/client-configuration) configuration. |
| **ConflictSolverConfig** | `ConflictSolver` | Define the strategy used to resolve [Replication conflicts](../../../server/clustering/replication/replication-conflicts). |
| **DataArchival** | `DataArchivalConfiguration` | [Data Archival](../../../server/extensions/archival) configuration for the database. |
| **DataArchival** | `DataArchivalConfiguration` | [Data Archival](../../../data-archival/overview) configuration for the database. |
| **DatabaseName** | `string` | The database name. |
| **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). |
| **DocumentsCompression** | `DocumentsCompressionConfiguration` | Configuration settings for [Compressing documents](../../../server/storage/documents-compression). |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
| **autoIndexes** | `Map<String, AutoIndexDefinition>` | Auto-index definitions for the database. |
| **client** | `ClientConfiguration` | [Client behavior](../../../studio/server/client-configuration) configuration. |
| **conflictSolverConfig** | `ConflictSolver` | Define the strategy used to resolve [Replication conflicts](../../../server/clustering/replication/replication-conflicts). |
| **dataArchival** | `DataArchivalConfiguration` | [Data Archival](../../../server/extensions/archival) configuration for the database. |
| **dataArchival** | `DataArchivalConfiguration` | [Data Archival](../../../data-archival/overview) configuration for the database. |
| **databaseName** | `String` | The database name. |
| **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). |
| **documentsCompression** | `DocumentsCompressionConfiguration` | Configuration settings for [Compressing documents](../../../server/storage/documents-compression). |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,7 @@
* **Misc**:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ConfigureExpirationOperation
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ConfigureRefreshOperation
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [ConfigureDataArchivalOperation](../../data-archival/enable-data-archiving#enable-archiving---from-the-client-api)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; UpdateDocumentsCompressionConfigurationOperation
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; DatabaseHealthCheckOperation
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; GetOperationStateOperation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,7 @@ __Send syntax__:
* __Misc__:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ConfigureExpirationOperation
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ConfigureRefreshOperation
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ConfigureDataArchivalOperation
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; UpdateDocumentsCompressionConfigurationOperation
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; DatabaseHealthCheckOperation
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; GetOperationStateOperation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,7 @@
* **Misc**:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ConfigureExpirationOperation
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ConfigureRefreshOperation
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ConfigureDataArchivalOperation
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; UpdateDocumentsCompressionConfigurationOperation
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; DatabaseHealthCheckOperation
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; GetOperationStateOperation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,7 @@
* **Misc**:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ConfigureExpirationOperation
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ConfigureRefreshOperation
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ConfigureDataArchivalOperation
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; UpdateDocumentsCompressionConfigurationOperation
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; DatabaseHealthCheckOperation
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; GetOperationStateOperation
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
[
{
"Path": "overview.markdown",
"Name": "Overview",
"DiscussionId": "28bb68b0-3af7-46b3-ad4c-e34b7e81565d",
"Mappings": [
{
"Version": 6.0,
"Key": "server/extensions/archival"
}
]
},
{
"Path": "enable-data-archiving.markdown",
"Name": "Enable Data Archiving",
"DiscussionId": "e5eeaaa7-bb98-4ae7-9cd1-75cb300738e7",
"Mappings": [
{
"Version": 6.0,
"Key": "server/extensions/archival"
}
]
},
{
"Path": "schedule-document-archiving.markdown",
"Name": "Schedule Document Archiving",
"DiscussionId": "ec35fa9a-834a-48b0-96c3-d67e1648cbae",
"Mappings": [
{
"Version": 6.0,
"Key": "server/extensions/archival"
}
]
},
{
"Path": "archived-documents-and-other-features.markdown",
"Name": "Archived Documents and Other Features",
"DiscussionId": "977c8625-ad1d-4dd9-8b29-eb92037957f8",
"Mappings": [
{
"Version": 6.0,
"Key": "server/extensions/archival"
}
]
},
{
"Path": "unarchiving-documents.markdown",
"Name": "Unarchiving Documents",
"DiscussionId": "a01cdd59-257e-4a0e-8ec6-07d7d7d3d239",
"Mappings": [
{
"Version": 6.0,
"Key": "server/extensions/archival"
}
]
}
]
Loading
Loading