Skip to content
Open
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
4 changes: 4 additions & 0 deletions docs/data-archival/api-studio-quick-links/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"position": 7,
"label": "API/Studio Quick Links"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: "Client API References"
sidebar_label: "Client API References"
sidebar_position: 1
---

import Admonition from '@theme/Admonition';

<Admonition type="note" title="">

Refer to the following links for managing data archival via the Client API:

* **Enable archiving**:
[Enable archiving - from the Client API](../../data-archival/enable-data-archiving#enable-archiving-from-the-client-api)

* **Schedule archiving**:
[Schedule a SINGLE document for archiving - from the Client API](../../data-archival/schedule-document-archiving#schedule-a-single-document-for-archiving-from-the-client-api)
[Schedule MULTIPLE documents for archiving - from the Client API](../../data-archival/schedule-document-archiving#schedule-multiple-documents-for-archiving-from-the-client-api)

* **Unarchive**:
[Unarchive documents - from the Client API](../../data-archival/unarchiving-documents#unarchive-documents-from-the-client-api)

* **Archiving and other features**:
[Archived documents and indexing](../../data-archival/archived-documents-and-other-features#archived-documents-and-indexing)
[Archived documents and subscriptions](../../data-archival/archived-documents-and-other-features#archived-documents-and-subscriptions)
[Archived documents and smuggler (export/import)](../../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-smuggler-export-import)
[Archived documents and expiration](../../data-archival/archived-documents-and-other-features#archived-documents-and-expiration)
[Archived documents and ETL](../../data-archival/archived-documents-and-other-features#archived-documents-and-etl)

</Admonition>
30 changes: 30 additions & 0 deletions docs/data-archival/api-studio-quick-links/studio-references.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: "Studio References"
sidebar_label: "Studio References"
sidebar_position: 0
---

import Admonition from '@theme/Admonition';

<Admonition type="note" title="">

Refer to the following links for managing data archival via Studio:

* **Overview**:
[The archived document](../../data-archival/overview#the-archived-document)

* **Enable & schedule**:
[Enable archiving](../../data-archival/enable-data-archiving#enable-archiving-from-the-studio)
[Schedule a single document for archiving](../../data-archival/enable-data-archiving#enable-archiving-from-the-studio)
[Schedule multiple documents for archiving](../../data-archival/schedule-document-archiving#schedule-multiple-documents-for-archiving-from-the-studio)

* **Unarchive**:
[Unarchive documents](../../data-archival/unarchiving-documents#unarchive-documents-from-the-studio)

* **Archiving and other features**:
[Configure how a static index handles archived documents](../../data-archival/archived-documents-and-other-features#configuring-archived-document-processing-for-a-static-index---from-the-studio)
[Configure how a subscription task handles archived documents](../../data-archival/archived-documents-and-other-features#configuring-archived-document-processing-for-a-data-subscription-task----from-the-studio)
[Export archived documents](../../data-archival/archived-documents-and-other-features#export-archived-documents---from-the-studio)
[Import archived documents](../../data-archival/archived-documents-and-other-features#import-archived-documents---from-the-studio)

</Admonition>
7 changes: 3 additions & 4 deletions docs/data-archival/archived-documents-and-other-features.mdx
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
---
title: "Archived Documents and Other Features"
sidebar_label: Archived Documents and Other Features
sidebar_position: 3
sidebar_label: "Archived Documents and Other Features"
sidebar_position: 4
supported_languages: ["csharp"]
---

import LanguageSwitcher from "@site/src/components/LanguageSwitcher";
import LanguageContent from "@site/src/components/LanguageContent";

import ArchivedDocumentsAndOtherFeaturesCsharp from './_archived-documents-and-other-features-csharp.mdx';

import ArchivedDocumentsAndOtherFeaturesCsharp from './content/_archived-documents-and-other-features-csharp.mdx';

<LanguageSwitcher supportedLanguages={frontMatter.supported_languages} />

Expand Down
85 changes: 85 additions & 0 deletions docs/data-archival/configuration.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
---
title: "Configuration"
sidebar_label: "Configuration"
sidebar_position: 6
---

import Admonition from '@theme/Admonition';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import CodeBlock from '@theme/CodeBlock';
import LanguageSwitcher from "@site/src/components/LanguageSwitcher";
import LanguageContent from "@site/src/components/LanguageContent";
import ContentFrame from '@site/src/components/ContentFrame';
import Panel from '@site/src/components/Panel';

# Data archival configuration

<Admonition type="note" title="">

* For an overview of what configuration options are and how they can be applied,
see the [Configuration Overview](../server/configuration/configuration-options) article.

* The following configuration options are available for data archival:
* [Indexing.Static.ArchivedDataProcessingBehavior](../data-archival/configuration#indexingstaticarchiveddataprocessingbehavior)
* [Indexing.Auto.ArchivedDataProcessingBehavior](../data-archival/configuration#indexingautoarchiveddataprocessingbehavior)
* [Subscriptions.ArchivedDataProcessingBehavior](../data-archival/configuration#subscriptionsarchiveddataprocessingbehavior)

</Admonition>

---

<ContentFrame>

## Indexing.Static.ArchivedDataProcessingBehavior

* 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 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

</ContentFrame>

<ContentFrame>

## Indexing.Auto.ArchivedDataProcessingBehavior

The default processing behavior for archived documents in auto-indexes.

- **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

</ContentFrame>

<ContentFrame>

## Subscriptions.ArchivedDataProcessingBehavior

The default processing behavior for archived documents in a subscription query.

- **Type**: `enum ArchivedDataProcessingBehavior`:
* `ExcludeArchived`: only non-archived documents are processed by the subscription query.
* `IncludeArchived`: both archived and non-archived documents are processed by the subscription query.
* `ArchivedOnly`: only archived documents are processed by the subscription query.

- **Default**: `ExcludeArchived`

- **Scope**: Server-wide, or per database

</ContentFrame>
Loading